Create Inventory Document 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 "View and select warehouses" permission and the "Create and edit" permission for the required document type
The method catalog.document.add creates an inventory document in draft status.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating the document (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
docType* |
Document type. Possible values:
The value is case-sensitive: the method rejects Type names can be retrieved with the catalog.enum.getStoreDocumentTypes method |
|
currency* |
Document currency code, for example The list of currencies can be retrieved with the crm.currency.list method |
|
responsibleId* |
Responsible user ID. The method does not check that the user exists. The method saves a non-numeric value as User IDs can be retrieved with the user.get method |
|
title |
Document name. If not passed, |
|
docNumber |
Document number. If not passed, |
|
dateDocument |
Document date, for example The method skips a string that cannot be parsed as a date without an error |
|
commentary |
Document comment |
|
total |
Document total. The method does not recalculate it from the products, including on processing. The method saves a non-numeric value as |
|
siteId |
Site code. Default is |
|
statusBy |
ID of the user who changed the document status. On processing and on canceling processing, the field gets the ID of the current user |
The method fills in the id, status, createdBy, modifiedBy, dateCreate, dateModify, and dateStatus fields itself: status is N, createdBy and modifiedBy are the ID of the current user, the dates are the creation time. The method skips passed values of these fields and unknown fields without an error.
Add products to the document with the catalog.document.element.add method, and the vendor with the catalog.documentcontractor.add method.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docType":"S","currency":"EUR","responsibleId":1269,"docNumber":"OP-00042","title":"Surplus stock adjustment","commentary":"Surplus found during stocktaking","dateDocument":"2026-11-05T10:00:00+03:00"}}' \
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":"S","currency":"EUR","responsibleId":1269,"docNumber":"OP-00042","title":"Surplus stock adjustment","commentary":"Surplus found during stocktaking","dateDocument":"2026-11-05T10:00:00+03:00"},"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
dateDocument: ISODate | null
dateModify: ISODate
dateStatus: ISODate
docNumber: string | null
docType: string
id: number
modifiedBy: number
responsibleId: number | null
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: 'S',
currency: 'USD',
responsibleId: 1269,
docNumber: 'OP-00042',
title: 'Surplus stock adjustment',
commentary: 'Surplus found during stocktaking',
dateDocument: '2026-11-05T10:00:00+03:00',
},
},
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:', result.document.id, 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: 'S',
currency: 'USD',
responsibleId: 1269,
docNumber: 'OP-00042',
title: 'Surplus stock adjustment',
commentary: 'Surplus found during stocktaking',
dateDocument: '2026-11-05T10:00:00+03:00',
},
},
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:', result.document.id, 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": "S",
"currency": "USD",
"responsibleId": 1269,
"docNumber": "OP-00042",
"title": "Surplus stock adjustment",
"commentary": "Surplus found during stocktaking",
"dateDocument": "2026-11-05T10:00:00+03:00",
},
).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}")
try {
$response = $b24Service
->core
->call(
'catalog.document.add',
[
'fields' => [
'docType' => 'S',
'currency' => 'EUR',
'responsibleId' => 1269,
'docNumber' => 'OP-00042',
'title' => 'Surplus stock adjustment',
'commentary' => 'Surplus found during stocktaking',
'dateDocument' => '2026-11-05T10:00:00+03:00',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.document.add',
{
fields: {
docType: 'S',
currency: 'USD',
responsibleId: 1269,
docNumber: 'OP-00042',
title: 'Surplus stock adjustment',
commentary: 'Surplus found during stocktaking',
dateDocument: '2026-11-05T10:00:00+03:00',
},
},
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' => 'S',
'currency' => 'USD',
'responsibleId' => 1269,
'docNumber' => 'OP-00042',
'title' => 'Surplus stock adjustment',
'commentary' => 'Surplus found during stocktaking',
'dateDocument' => '2026-11-05T10:00:00+03:00',
]
]
);
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": "S",
"currency": "EUR",
"responsibleId": 1269,
"docNumber": "OP-00042",
"title": "Surplus stock adjustment",
"commentary": "Surplus found during stocktaking",
"dateDocument": "2026-11-05T10:00:00+03:00",
},
})
if err != nil {
return fmt.Errorf("catalog.document.add: %w", err)
}
// The method wraps the response in an object with the "document" key.
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
return fmt.Errorf("no document key in the response")
}
// Optional fields can be null, so pointers are used for them.
var item struct {
ID b24.ID `json:"id"`
DocType string `json:"docType"`
Status string `json:"status"`
Currency string `json:"currency"`
Title *string `json:"title"`
DocNumber *string `json:"docNumber"`
Commentary *string `json:"commentary"`
ResponsibleID *int `json:"responsibleId"`
DateDocument *string `json:"dateDocument"`
DateCreate string `json:"dateCreate"`
Total *float64 `json:"total"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Status)
Response Handling
HTTP status: 200
{
"result": {
"document": {
"commentary": "Surplus found during stocktaking",
"createdBy": 1269,
"currency": "USD",
"dateCreate": "2026-11-05T15:58:42+03:00",
"dateDocument": "2026-11-05T10:00:00+03:00",
"dateModify": "2026-11-05T15:58:42+03:00",
"dateStatus": "2026-11-05T15:58:42+03:00",
"docNumber": "OP-00042",
"docType": "S",
"id": 381,
"modifiedBy": 1269,
"responsibleId": 1269,
"siteId": "s1",
"status": "N",
"statusBy": null,
"title": "Surplus stock adjustment",
"total": null
}
},
"time": {
"start": 1793883522,
"finish": 1793883522.271001,
"duration": 0.27100110054016113,
"processing": 0,
"date_start": "2026-11-05T15:58:42+03:00",
"date_finish": "2026-11-05T15:58:42+03:00",
"operating_reset_at": 1793884080,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.document |
Object with the fields of the created document. The method returns all document fields, including empty ones with the value The document is created in status |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Required fields: docType, responsibleId, currency"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Cannot complete action because you don't have sufficient permissions to view and select warehouses. |
The user does not have the "View and select warehouses" permission |
|
|
|
Insufficient permissions to save the inventory object. |
The user does not have the "Create and edit" permission for documents of this type or has no catalog permissions |
|
|
|
Could not find value for parameter |
The |
|
|
|
Invalid value {abc} to match with parameter {fields}. Should be value of type array. |
|
|
|
|
Required fields: docType, responsibleId, currency |
Required fields are not passed. The text lists only the missing fields |
|
|
|
DOC_TYPE isn't available |
|
|
|
|
Wrong format of field |
The field contains an array or an object instead of a value. The text contains the field name |
|
|
|
Inventory Management is not available on your plan. |
Inventory Management is not available on the account plan |
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 catalog.document.update
- Get List of Inventory Documents catalog.document.list
- Process Inventory Document catalog.document.conduct
- Get Description of Fields for Inventory Document catalog.document.getFields
- Add Product to Inventory Document catalog.document.element.add
- Add Vendor to Inventory Document catalog.documentcontractor.add