Получить документ складского учета по идентификатору catalog.document.get

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр и выбор склада» или «Просмотр каталога товаров»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.document.get возвращает поля документа складского учета по идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор документа.

Идентификатор можно получить методом catalog.document.list или из ответа catalog.document.add.

Метод возвращает документ, только если у пользователя есть право «Просмотр» на его тип. Иначе метод вернет ошибку доступа

select
array

Массив полей документа, которые нужно вернуть в ответе.

Доступные поля:

id — идентификатор документа
docType — тип документа
siteId — идентификатор сайта
responsibleId — идентификатор ответственного
dateModify — дата изменения
dateCreate — дата создания
createdBy — кто создал
modifiedBy — кто изменил
currency — валюта
status — статус проведения
dateStatus — дата изменения статуса
dateDocument — дата документа
statusBy — кто изменил статус
total — сумма
commentary — комментарий
title — название
docNumber — номер входящего документа
contractorId — идентификатор поставщика

Поле id возвращается всегда, даже если его нет в select. Значение ["*"] не поддерживается.

По умолчанию: все поля

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.document.get

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":343,"select":["id","docType","title","status","total","currency","dateDocument"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":343,"select":["id","docType","title","status","total","currency","dateDocument"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.get

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentGetResult = {
  item: {
    id: number
    docType: string
    currency: string
    status: string
    dateDocument: ISODate | null
    total: number
    title: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentGetResult>({
    method: 'catalog.document.get',
    params: {
      id: 343,
      select: ['id', 'docType', 'title', 'status', 'total', 'currency', 'dateDocument'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document:', result.item.id, result.item.title, result.item.status)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function callDocumentGet() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.get',
        params: {
          id: 343,
          select: ['id', 'docType', 'title', 'status', 'total', 'currency', 'dateDocument'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Document:', result.item.id, result.item.title, result.item.status)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', callDocumentGet)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.get(
        id=343,
        select=["id", "docType", "title", "status", "total", "currency", "dateDocument"],
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.document.get',
            [
                'id' => 343,
                'select' => ['id', 'docType', 'title', 'status', 'total', 'currency', 'dateDocument'],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.document.get',
    {
        id: 343,
        select: ['id', 'docType', 'title', 'status', 'total', 'currency', 'dateDocument'],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.document.get',
    [
        'id' => 343,
        'select' => ['id', 'docType', 'title', 'status', 'total', 'currency', 'dateDocument'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.get", b24.Params{
	"id":     343,
	"select": []string{"id", "docType", "title", "status", "total", "currency", "dateDocument"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.document.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID       int     `json:"id"`
	DocType  string  `json:"docType"`
	Title    string  `json:"title"`
	Status   string  `json:"status"`
	Total    float64 `json:"total"`
	Currency string  `json:"currency"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title, item.Status)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 343,
            "docType": "A",
            "currency": "RUB",
            "status": "",
            "dateDocument": "2026-10-22T10:00:00+03:00",
            "total": 15000,
            "title": "Приход от поставщика ООО Альфа"
        }
    },
    "time": {
        "start": 1792665249,
        "finish": 1792665249.695711,
        "duration": 0.6957108974456787,
        "processing": 0,
        "date_start": "2026-10-22T13:34:09+03:00",
        "date_finish": "2026-10-22T13:34:09+03:00",
        "operating_reset_at": 1792665840,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Поля документа. Состав зависит от `select`. Описание полей
time `time`	Информация о времени выполнения запроса

Объект item

Название `тип`	Описание
id `integer`	Идентификатор документа
docType `string`	Тип документа: `A` — приход, `S` — оприходование, `M` — перемещение, `R` — возврат, `D` — списание
siteId `string`	Идентификатор сайта, например `s1`
responsibleId `integer`	Идентификатор ответственного
dateModify `datetime`	Дата и время последнего изменения
dateCreate `datetime`	Дата и время создания
createdBy `integer`	Идентификатор пользователя, который создал документ
modifiedBy `integer`	Идентификатор пользователя, который последним изменил документ
currency `string`	Код валюты документа, например `RUB`
status `string`	Статус проведения: `"1"` — документ проведен, пустая строка — не проведен
dateStatus `datetime`	Дата и время последнего изменения статуса
dateDocument `datetime` или `null`	Дата документа. `null`, если дата не задана
statusBy `integer`	Идентификатор пользователя, который последним изменил статус. `0`, если статус не менялся
total `double`	Сумма документа
commentary `string`	Комментарий
title `string`	Название документа
docNumber `string`	Номер входящего документа
contractorId `integer`	Идентификатор поставщика из справочника каталога. `0`, если поставщик не указан

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `999999` не найдена"
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Обязательное поле `id` не указано	Передайте в `id` положительное целое число

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Запись с ID = `#ID#` не найдена	Проверьте идентификатор методом catalog.document.list

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`select`	Неизвестное поле `#FIELD#` для сущности `DocumentDto`	Укажите в `select` только поля из описания параметра `select`

Ошибка формата select

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле	Описание ошибки	Как исправить
`select`	Не удается распознать выражение select `#SELECT#`	Передайте `select` массивом строк, например `["id","title"]`

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Проверьте, что у пользователя есть право «Просмотр» на тип документа

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Получить список документов складского учета v 3.0

Удалить документ

Получить документ складского учета по идентификатору catalog.document.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект itemОбъект item

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

Ошибка отсутствия объектаОшибка отсутствия объекта

Ошибка неизвестного поляОшибка неизвестного поля

Ошибка формата selectОшибка формата select

Ошибка доступаОшибка доступа

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Параметры метода

Примеры кода

Обработка ответа

Возвращаемые данные

Объект item

Обработка ошибок

Возможные коды ошибок

Ошибки валидации запроса

Ошибка отсутствия объекта

Ошибка неизвестного поля

Ошибка формата select

Ошибка доступа

Статусы и коды системных ошибок

Продолжите изучение