Создать документ складского учета catalog.document.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Cоздание и редактирование» на нужный тип документа
Метод catalog.document.add создает новый документ складского учета.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Поля документа (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
docType* |
Тип документа. Возможные значения:
Актуальные типы документов можно получить методом catalog.enum.getStoreDocumentTypes |
|
currency* |
Валюта документа в формате ISO 4217, например Чтобы получить список валют с кодами используйте метод crm.currency.list |
|
responsibleId* |
Идентификатор ответственного |
|
siteId |
Код сайта, к которому относится документ. По умолчанию — Параметр актуален для коробочных Битрикс, для облачных Битрикс значение стандратное — |
|
dateDocument |
Дата проведения документа в формате ISO 8601 |
|
title |
Название документа |
|
commentary |
Комментарий к документу |
|
total |
Общая сумма по товарам документа. Значение рассчитывается автоматически после проведения, но может быть задано вручную |
|
docNumber |
Внутренний номер документа. Если не передать, генерируется автоматически |
|
createdBy |
Идентификатор пользователя, создавшего документ. Администратор может указать любое значение, по умолчанию заполняется текущим пользователем |
Чтобы заполнить данные о поставщике, используйте метод catalog.documentcontractor.add.
Чтобы заполнить данные по товарам, используйте метод catalog.document.element.add.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docType":"A","currency":"RUB","responsibleId":29,"docNumber":"IN-00042","title":"Поступление от Поставщик-1","commentary":"Плановое пополнение склада"}}' \
https://**put_your_bitrix24_address**/rest/**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":29,"docNumber":"IN-00042","title":"Поступление от Поставщик-1","commentary":"Плановое пополнение склада"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentAddResult = {
document: {
commentary: string | null,
createdBy: number,
currency: string,
dateCreate: ISODate | null,
dateDocument: ISODate | null,
dateModify: ISODate | null,
dateStatus: ISODate | null,
docNumber: string,
docType: string,
id: number,
modifiedBy: number,
responsibleId: number,
siteId: string,
status: string,
statusBy: number | null,
title: string | null,
total: number | null,
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentAddResult>({
method: 'catalog.document.add',
params: {
fields: {
docType: 'A',
currency: 'RUB',
responsibleId: 29,
docNumber: 'IN-00042',
title: 'Goods receipt from Supplier-1',
commentary: 'Planned warehouse replenishment',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created document with ID:', result.document.id, 'status:', result.document.status)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.add',
params: {
fields: {
docType: 'A',
currency: 'RUB',
responsibleId: 29,
docNumber: 'IN-00042',
title: 'Goods receipt from Supplier-1',
commentary: 'Planned warehouse replenishment',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created document with ID:', result.document.id, 'status:', result.document.status)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addDocument)
</script>
try {
$response = $b24Service
->core
->call(
'catalog.document.add',
[
'fields' => [
'docType' => 'A',
'currency' => 'RUB',
'responsibleId' => 29,
'docNumber' => 'IN-00042',
'title' => 'Поступление от Поставщик-1',
'commentary' => 'Плановое пополнение склада'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding product row: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.add',
{
fields: {
docType: 'A',
currency: 'RUB',
responsibleId: 29,
docNumber: 'IN-00042',
title: 'Поступление от Поставщик-1',
commentary: 'Плановое пополнение склада'
}
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.add',
[
'fields' => [
'docType' => 'A',
'currency' => 'RUB',
'responsibleId' => 29,
'docNumber' => 'IN-00042',
'title' => 'Поступление от Поставщик-1',
'commentary' => 'Плановое пополнение склада'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-код: 200
{
"result": {
"document": {
"commentary": "Плановое пополнение склада",
"createdBy": 29,
"currency": "RUB",
"dateCreate": "2025-10-30T11:19:38+03:00",
"dateDocument": null,
"dateModify": "2025-10-30T11:19:38+03:00",
"dateStatus": "2025-10-30T11:19:38+03:00",
"docNumber": "IN-00042",
"docType": "A",
"id": 11,
"modifiedBy": 29,
"responsibleId": 29,
"siteId": "s1",
"status": "N",
"statusBy": null,
"title": "Поступление от Поставщик-1",
"total": null
}
},
"time": {
"start": 1761805178,
"finish": 1761805178.991429,
"duration": 0.9914290904998779,
"processing": 0,
"date_start": "2025-10-30T09:19:38+03:00",
"date_finish": "2025-10-30T09:19:38+03:00",
"operating_reset_at": 1761805778,
"operating": 0.2595658302307129
}
}
Документ создается в статусе N — черновик. Чтобы провести документ, используйте метод catalog.document.conduct или catalog.document.conductList.
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
document |
Объект с данными созданного документа |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
HTTP-код: 400
{
"error": "0",
"error_description": "DOC_TYPE isn't available"
}
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Недостаточно прав для сохранения документа |
У пользователя нет права на создание документа нужного типа |
|
|
DOC_TYPE isn't available |
Передан недопустимый тип документа |
|
|
Складской учет недоступен на вашем тарифе |
Складской учет недоступен на вашем тарифе |
|
|
- |
Иные внутренние ошибки при добавлении документа |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |