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

Scope: catalog

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

Метод catalog.document.add создает новый документ складского учета.

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

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

Название `тип`	Описание
fields* `object`	Поля документа (подробное описание)

Параметр fields

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

Название `тип`	Описание
docType* `char`	Тип документа. Возможные значения: `A` — поступление, `S` — оприходование, `M` — перемещение между складами, `R` — возврат, `D` — списание. Актуальные типы документов можно получить методом catalog.enum.getStoreDocumentTypes
currency* `crm_currency.CURRENCY`	Валюта документа в формате ISO 4217, например `RUB`. Значение нельзя изменить после создания. Чтобы получить список валют с кодами используйте метод crm.currency.list
responsibleId* `user.id`	Идентификатор ответственного
siteId `char`	Код сайта, к которому относится документ. По умолчанию — `s1`. Параметр актуален для коробочных Битрикс, для облачных Битрикс значение стандратное — `s1`
dateDocument `datetime`	Дата проведения документа в формате ISO 8601
title `string`	Название документа
commentary `char`	Комментарий к документу
total `double`	Общая сумма по товарам документа. Значение рассчитывается автоматически после проведения, но может быть задано вручную
docNumber `string`	Внутренний номер документа. Если не передать, генерируется автоматически
createdBy `user.id`	Идентификатор пользователя, создавшего документ. Администратор может указать любое значение, по умолчанию заполняется текущим пользователем

Чтобы заполнить данные о поставщике, используйте метод catalog.documentcontractor.add.
Чтобы заполнить данные по товарам, используйте метод catalog.document.element.add.

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'catalog.document.add',
                {
                    fields: {
                        docType: 'A',
                        currency: 'RUB',
                        responsibleId: 29,
                        docNumber: 'IN-00042',
                        title: 'Поступление от Поставщик-1',
                        commentary: 'Плановое пополнение склада',
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Created element with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

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 `object`	Корневой элемент ответа
document `catalog_document`	Объект с данными созданного документа
time `time`	Информация о времени выполнения запроса

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

HTTP-код: 400

{
            "error": "0",
            "error_description": "DOC_TYPE isn't available"
        }

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

Код	Описание	Значение
`0`	Недостаточно прав для сохранения документа	У пользователя нет права на создание документа нужного типа
`0`	DOC_TYPE isn't available	Передан недопустимый тип документа
`0`	Складской учет недоступен на вашем тарифе	Складской учет недоступен на вашем тарифе
`0`	-	Иные внутренние ошибки при добавлении документа

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Отменить проведение документа

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

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

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

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

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

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

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

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

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

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