метод REST scope: catalog

catalog.document.add

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

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

Описание

Метод 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 необязательный

Идентификатор пользователя, создавшего документ. Администратор может указать любое значение, по умолчанию заполняется текущим пользователем

Примеры запроса

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

Ответ

{
    "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
    }
}

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

result object

Корневой элемент ответа

document catalog_document

Объект с данными созданного документа

time time

Информация о времени выполнения запроса

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

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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.