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:
catalogWho 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 |
Description |
|
fields* |
An object with the fields of the new inventory document. Field description |
Parameter fields
|
Name |
Description |
|
docType* |
Document type. The type cannot be changed after creation. Possible values:
The list of types and their names is returned by the catalog.document.type.list method |
|
currency* |
Document currency code, for example |
|
responsibleId* |
Identifier of the responsible person. The user identifier can be retrieved using the user.get method |
|
title |
Document title. If not passed, Bitrix24 generates the title from the type and number, for example "Stock receipt #37" |
|
docNumber |
Incoming document number |
|
dateDocument |
Document date in ISO 8601 format with time, for example |
|
total |
Document total |
|
commentary |
Comment |
|
siteId |
Site identifier. Default: |
|
statusBy |
Identifier of the user who last changed the status |
|
modifiedBy |
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 |
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 |
Description |
|
result |
An object with the response data |
|
result.item |
Fields of the created document. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Document identifier |
|
docType |
Document type: |
|
siteId |
Site identifier, for example |
|
responsibleId |
Identifier of the responsible person |
|
dateModify |
Date and time of the last change |
|
dateCreate |
Date and time of creation |
|
createdBy |
Identifier of the user who created the document |
|
modifiedBy |
Identifier of the user who last modified the document |
|
currency |
Document currency code, for example |
|
status |
Processing status: |
|
dateStatus |
Date and time of the last status change |
|
dateDocument |
Document date. |
|
statusBy |
Identifier of the user who last changed the status. |
|
total |
Document total |
|
commentary |
Comment |
|
title |
Document title |
|
docNumber |
Incoming document number |
|
contractorId |
Identifier of the vendor from the catalog directory. |
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 |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Field |
Remove the |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass an integer |
|
|
This request requires data type |
Pass a date with time in ISO 8601 format, for example |
|
|
DOC_TYPE isn't available |
Pass one of the types |
|
|
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 |
Pass only the fields from the Parameter fields table in |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Update Inventory Document v 3.0 catalog.document.update
- Get Inventory Document by ID catalog.document.get
- Get List of Inventory Documents v 3.0 catalog.document.list
- Delete Inventory Document v 3.0 catalog.document.delete
- Delete Multiple Inventory Documents v 3.0 catalog.document.deletelist
- Get List of Inventory Document Fields v 3.0 catalog.document.field.list
- Get Inventory Document Field catalog.document.field.get
- Add Product to Inventory Document v 3.0 catalog.document.element.add