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

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

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

Scope: catalog

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

Метод 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 -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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.add(
        fields={
            "docType": "A",
            "currency": "RUB",
            "responsibleId": 29,
            "docNumber": "IN-00042",
            "title": "Поступление от Поставщик-1",
            "commentary": "Плановое пополнение склада",
        },
    ).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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.add", b24.Params{
	"fields": b24.Params{
		"docType":       "A",
		"currency":      "RUB",
		"responsibleId": 29,
		"docNumber":     "IN-00042",
		"title":         "Поступление от Поставщик-1",
		"commentary":    "Плановое пополнение склада",
	},
})
if err != nil {
	return fmt.Errorf("catalog.document.add: %w", err)
}

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

var item struct {
	Commentary string `json:"commentary"`
	CreatedBy  int    `json:"createdBy"`
	Currency   string `json:"currency"`
	DateCreate string `json:"dateCreate"`
	DateModify string `json:"dateModify"`
	DateStatus string `json:"dateStatus"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Commentary, item.CreatedBy)

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

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

HTTP-код: 400

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

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

Код

Описание

Значение

0

Недостаточно прав для сохранения документа

У пользователя нет права на создание документа нужного типа

0

DOC_TYPE isn't available

Передан недопустимый тип документа

0

Складской учет недоступен на вашем тарифе

Складской учет недоступен на вашем тарифе

0

-

Иные внутренние ошибки при добавлении документа

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

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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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