Create Inventory Document v 3.0 catalog.document.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: catalog

Who can execute the method: a user with the "Create and edit" permission for the required document type

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.document.add method creates an inventory document and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object with the fields of the new inventory document. Field description

Parameter fields

Name
type

Description

docType*
string

Document type. The type cannot be changed after creation.

Possible values:

  • A — receipt of goods to a warehouse
  • S — stock adjustment
  • M — transfer of goods between warehouses
  • R — return of goods
  • D — write-off of goods

The list of types and their names is returned by the catalog.document.type.list method

currency*
string

Document currency code, for example EUR

responsibleId*
integer

Identifier of the responsible person.

The user identifier can be retrieved using the user.get method

title
string

Document title. If not passed, Bitrix24 generates the title from the type and number, for example "Stock receipt #37"

docNumber
string

Incoming document number

dateDocument
datetime

Document date in ISO 8601 format with time, for example 2026-10-22T10:00:00+02:00. A date without time causes a validation error

total
double

Document total

commentary
string

Comment

siteId
string

Site identifier.

Default: s1

statusBy
integer

Identifier of the user who last changed the status

modifiedBy
integer

Identifier of the user who last modified the document. The value is saved only if the method is called by an administrator. Otherwise, the current user is set

contractorId
integer

Identifier of the vendor from the catalog directory. If vendors are managed in CRM in Bitrix24, the field is not saved. To bind a CRM vendor to the document, use the catalog.document.contractor.add method

The id, dateCreate, dateModify, createdBy, status, and dateStatus fields are filled in automatically. If you pass them in fields, the method returns an error.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"docType":"A","currency":"EUR","responsibleId":1,"title":"Receipt from vendor","docNumber":"IN-0015","commentary":"Delivery under invoice 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":"EUR","responsibleId":1,"title":"Receipt from vendor","docNumber":"IN-0015","commentary":"Delivery under invoice 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: 'EUR',
                responsibleId: 1,
                title: 'Receipt from vendor',
                docNumber: 'IN-0015',
                commentary: 'Delivery under invoice 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: 'EUR',
                    responsibleId: 1,
                    title: 'Receipt from vendor',
                    docNumber: 'IN-0015',
                    commentary: 'Delivery under invoice 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": "EUR",
                    "responsibleId": 1,
                    "title": "Receipt from vendor",
                    "docNumber": "IN-0015",
                    "commentary": "Delivery under invoice 15",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.add',
                    [
                        'fields' => [
                            'docType' => 'A',
                            'currency' => 'EUR',
                            'responsibleId' => 1,
                            'title' => 'Receipt from vendor',
                            'docNumber' => 'IN-0015',
                            'commentary' => 'Delivery under invoice 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();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.document.add',
            {
                fields: {
                    docType: 'A',
                    currency: 'EUR',
                    responsibleId: 1,
                    title: 'Receipt from vendor',
                    docNumber: 'IN-0015',
                    commentary: 'Delivery under invoice 15',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.add',
            [
                'fields' => [
                    'docType' => 'A',
                    'currency' => 'EUR',
                    'responsibleId' => 1,
                    'title' => 'Receipt from vendor',
                    'docNumber' => 'IN-0015',
                    'commentary' => 'Delivery under invoice 15',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.document.add", b24.Params{
        	"fields": b24.Params{
        		"docType":       "A",
        		"currency":      "EUR",
        		"responsibleId": 1,
        		"title":         "Receipt from vendor",
        		"docNumber":     "IN-0015",
        		"commentary":    "Delivery under invoice 15",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.document.add: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        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("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Title, item.Status)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 343,
                    "docType": "A",
                    "siteId": "s1",
                    "responsibleId": 1,
                    "dateModify": "2026-10-22T13:34:07+02:00",
                    "dateCreate": "2026-10-22T13:34:07+02:00",
                    "createdBy": 1,
                    "modifiedBy": 1,
                    "currency": "EUR",
                    "status": "",
                    "dateStatus": "2026-10-22T13:34:07+02:00",
                    "dateDocument": null,
                    "statusBy": 0,
                    "total": 0,
                    "commentary": "Delivery under invoice 15",
                    "title": "Receipt from vendor",
                    "docNumber": "IN-0015",
                    "contractorId": 0
                }
            },
            "time": {
                "start": 1792665246,
                "finish": 1792665246.674998,
                "duration": 0.6749980449676514,
                "processing": 0,
                "date_start": "2026-10-22T13:34:06+02:00",
                "date_finish": "2026-10-22T13:34:06+02:00",
                "operating_reset_at": 1792665540,
                "operating": 0.3588740825653076
            }
        }
        

Returned Data

Name
type

Description

result
object

An object with the response data

result.item
object

Fields of the created document. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Document identifier

docType
string

Document type: A — receipt, S — stock adjustment, M — transfer, R — return, D — write-off

siteId
string

Site identifier, for example s1

responsibleId
integer

Identifier of the responsible person

dateModify
datetime

Date and time of the last change

dateCreate
datetime

Date and time of creation

createdBy
integer

Identifier of the user who created the document

modifiedBy
integer

Identifier of the user who last modified the document

currency
string

Document currency code, for example EUR

status
string

Processing status: "1" — the document is processed, an empty string — not processed

dateStatus
datetime

Date and time of the last status change

dateDocument
datetime or null

Document date. null if the date is not set

statusBy
integer

Identifier of the user who last changed the status. 0 if the status has not changed

total
double

Document total

commentary
string

Comment

title
string

Document title

docNumber
string

Incoming document number

contractorId
integer

Identifier of the vendor from the catalog directory. 0 if no vendor is specified

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Required field \"responsibleId\" is empty.",
                        "field": "responsibleId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

docType

Required field docType is empty

Pass docType in fields

currency

Required field currency is empty

Pass currency in fields

responsibleId

Required field responsibleId is empty

Pass responsibleId in fields

#FIELD#

Field #FIELD# is read-only

Remove the id, dateCreate, dateModify, createdBy, status, and dateStatus fields from fields

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

responsibleId

This request requires data type int in field responsibleId

Pass an integer

dateDocument

This request requires data type DateTime in field dateDocument

Pass a date with time in ISO 8601 format, for example 2026-10-22T10:00:00+02:00

-

DOC_TYPE isn't available

Pass one of the types A, S, M, R, D in docType

-

Inventory Management is not available on your plan

The method works only on plans with inventory management

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity DocumentDto

Pass only the fields from the Parameter fields table in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Make sure the user has the "Create and edit" permission for this document type

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning