Создать документ складского учета v 3.0 catalog.document.add

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

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

Scope: catalog

Кто может выполнять метод: пользователь с правом «Создание и редактирование» на нужный тип документа

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

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

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

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

Название `тип`	Описание
fields* `object`	Объект с полями нового документа складского учета. Описание полей

Параметр fields

Название `тип`	Описание
docType* `string`	Тип документа. После создания тип изменить нельзя. Возможные значения: `A` — приход товара на склад `S` — оприходование товара `M` — перемещение товара между складами `R` — возврат товара `D` — списание товара Список типов и их названия возвращает метод catalog.document.type.list
currency* `string`	Код валюты документа, например `RUB`
responsibleId* `integer`	Идентификатор ответственного. Идентификатор пользователя можно получить методом user.get
title `string`	Название документа. Если не передать, Битрикс24 сформирует название по типу и номеру, например «Приходная накладная #37»
docNumber `string`	Номер входящего документа
dateDocument `datetime`	Дата документа в формате ISO 8601 с временем, например `2026-10-22T10:00:00+03:00`. Дата без времени вызывает ошибку валидации
total `double`	Сумма документа
commentary `string`	Комментарий
siteId `string`	Идентификатор сайта. По умолчанию: `s1`
statusBy `integer`	Идентификатор пользователя, который последним изменил статус
modifiedBy `integer`	Идентификатор пользователя, который последним изменил документ. Значение сохраняется, только если метод вызывает администратор. В остальных случаях подставляется текущий пользователь
contractorId `integer`	Идентификатор поставщика из справочника каталога. Если в Битрикс24 поставщики ведутся в CRM, поле не сохраняется. Привязать поставщика CRM к документу можно методом catalog.document.contractor.add

Поля id, dateCreate, dateModify, createdBy, status и dateStatus заполняются автоматически. Если передать их в fields, метод вернет ошибку.

Примеры кода

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

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

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

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 '{"fields":{"docType":"A","currency":"RUB","responsibleId":1,"title":"Приход от поставщика","docNumber":"IN-0015","commentary":"Поставка по счету 15"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docType":"A","currency":"RUB","responsibleId":1,"title":"Приход от поставщика","docNumber":"IN-0015","commentary":"Поставка по счету 15"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.add

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

declare const $b24: B24Frame

type DocumentAddResult = {
  item: {
    id: number
    docType: string
    siteId: string
    responsibleId: number
    dateModify: ISODate
    dateCreate: ISODate
    createdBy: number
    modifiedBy: number
    currency: string
    status: string
    dateStatus: ISODate
    dateDocument: ISODate | null
    statusBy: number
    total: number
    commentary: string
    title: string
    docNumber: string
    contractorId: number
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentAddResult>({
    method: 'catalog.document.add',
    params: {
      fields: {
        docType: 'A',
        currency: 'RUB',
        responsibleId: 1,
        title: 'Приход от поставщика',
        docNumber: 'IN-0015',
        commentary: 'Поставка по счету 15',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document created:', result.item.id)
  }
} 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 callDocumentAdd() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.add',
        params: {
          fields: {
            docType: 'A',
            currency: 'RUB',
            responsibleId: 1,
            title: 'Приход от поставщика',
            docNumber: 'IN-0015',
            commentary: 'Поставка по счету 15',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.add(
        fields={
            "docType": "A",
            "currency": "RUB",
            "responsibleId": 1,
            "title": "Приход от поставщика",
            "docNumber": "IN-0015",
            "commentary": "Поставка по счету 15",
        },
    ).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.add',
            [
                'fields' => [
                    'docType' => 'A',
                    'currency' => 'RUB',
                    'responsibleId' => 1,
                    'title' => 'Приход от поставщика',
                    'docNumber' => 'IN-0015',
                    'commentary' => 'Поставка по счету 15',
                ],
            ]
        );

    $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.add',
    {
        fields: {
            docType: 'A',
            currency: 'RUB',
            responsibleId: 1,
            title: 'Приход от поставщика',
            docNumber: 'IN-0015',
            commentary: 'Поставка по счету 15',
        },
    },
    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.add',
    [
        'fields' => [
            'docType' => 'A',
            'currency' => 'RUB',
            'responsibleId' => 1,
            'title' => 'Приход от поставщика',
            'docNumber' => 'IN-0015',
            'commentary' => 'Поставка по счету 15',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.add", b24.Params{
	"fields": b24.Params{
		"docType":       "A",
		"currency":      "RUB",
		"responsibleId": 1,
		"title":         "Приход от поставщика",
		"docNumber":     "IN-0015",
		"commentary":    "Поставка по счету 15",
	},
})
if err != nil {
	return fmt.Errorf("catalog.document.add: %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",
            "siteId": "s1",
            "responsibleId": 1,
            "dateModify": "2026-10-22T13:34:07+03:00",
            "dateCreate": "2026-10-22T13:34:07+03:00",
            "createdBy": 1,
            "modifiedBy": 1,
            "currency": "RUB",
            "status": "",
            "dateStatus": "2026-10-22T13:34:07+03:00",
            "dateDocument": null,
            "statusBy": 0,
            "total": 0,
            "commentary": "Поставка по счету 15",
            "title": "Приход от поставщика",
            "docNumber": "IN-0015",
            "contractorId": 0
        }
    },
    "time": {
        "start": 1792665246,
        "finish": 1792665246.674998,
        "duration": 0.6749980449676514,
        "processing": 0,
        "date_start": "2026-10-22T13:34:06+03:00",
        "date_finish": "2026-10-22T13:34:06+03:00",
        "operating_reset_at": 1792665540,
        "operating": 0.3588740825653076
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Поля созданного документа. Описание полей
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_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"responsibleId\"",
                "field": "responsibleId"
            }
        ]
    }
}

Название `тип`	Описание
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_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`docType`	Не заполнено обязательное поле "docType"	Передайте `docType` в `fields`
`currency`	Не заполнено обязательное поле "currency"	Передайте `currency` в `fields`
`responsibleId`	Не заполнено обязательное поле "responsibleId"	Передайте `responsibleId` в `fields`
`#FIELD#`	Поле "#FIELD#" не доступно к заполнению	Уберите из `fields` поля `id`, `dateCreate`, `dateModify`, `createdBy`, `status`, `dateStatus`

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`fields`	Обязательное поле `fields` не указано	Передайте объект `fields`
`responsibleId`	В поле `responsibleId` требуется тип данных `int` для такого запроса	Передайте целое число
`dateDocument`	В поле `dateDocument` требуется тип данных `DateTime` для такого запроса	Передайте дату с временем в формате ISO 8601, например `2026-10-22T10:00:00+03:00`
`-`	DOC_TYPE isn't available	Передайте в `docType` один из типов `A`, `S`, `M`, `R`, `D`
`-`	Складской учёт недоступен на вашем тарифе	Метод работает только на тарифах со складским учетом

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `DocumentDto`	Передайте в `fields` только поля из таблицы Параметр fields

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

Код ошибки: 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.add

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

Ошибки валидации объектаОшибки валидации объекта

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

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

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

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

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

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

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

Параметр fields

Примеры кода

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

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

Объект item

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

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

Ошибки валидации объекта

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

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

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

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

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