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 "Create and edit" permission for the required document type
The method catalog.document.add creates a new inventory document.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Document fields (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
docType* |
Document type. Possible values:
Current document types can be obtained using the method catalog.enum.getStoreDocumentTypes |
|
currency* |
Document currency in ISO 4217 format, for example To get a list of currencies with codes, use the method crm.currency.list |
|
responsibleId* |
Identifier of the responsible person |
|
siteId |
Site code to which the document relates. Default is This parameter is relevant for on-premise Bitrix, for cloud Bitrix the standard value is |
|
dateDocument |
Document date in ISO 8601 format |
|
title |
Document title |
|
commentary |
Document commentary |
|
total |
Total amount for the document items. The value is calculated automatically after processing but can be set manually |
|
docNumber |
Internal document number. If not provided, it is generated automatically |
|
createdBy |
Identifier of the user who created the document. An administrator can specify any value; by default, it is filled with the current user |
To fill in supplier data, use the method catalog.documentcontractor.add.
To fill in product data, use the method catalog.document.element.add.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docType":"A","currency":"USD","responsibleId":29,"docNumber":"IN-00042","title":"Receipt from Supplier-1","commentary":"Planned warehouse replenishment"}}' \
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":"USD","responsibleId":29,"docNumber":"IN-00042","title":"Receipt from Supplier-1","commentary":"Planned warehouse replenishment"},"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: 'USD',
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: 'USD',
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": "USD",
"responsibleId": 29,
"docNumber": "IN-00042",
"title": "Receipt from Vendor-1",
"commentary": "Scheduled warehouse replenishment",
},
).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' => 'A',
'currency' => 'USD',
'responsibleId' => 29,
'docNumber' => 'IN-00042',
'title' => 'Receipt from Supplier-1',
'commentary' => 'Planned warehouse replenishment'
]
]
);
$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: 'USD',
responsibleId: 29,
docNumber: 'IN-00042',
title: 'Receipt from Supplier-1',
commentary: 'Planned warehouse replenishment'
}
},
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' => 'USD',
'responsibleId' => 29,
'docNumber' => 'IN-00042',
'title' => 'Receipt from Supplier-1',
'commentary' => 'Planned warehouse replenishment'
]
]
);
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": 29,
"docNumber": "IN-00042",
"title": "Receipt from Supplier-1",
"commentary": "Planned warehouse replenishment",
},
})
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")
}
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("parse response: %w", err)
}
fmt.Println(item.Commentary, item.CreatedBy)
Response Handling
HTTP code: 200
{
"result": {
"document": {
"commentary": "Planned warehouse replenishment",
"createdBy": 29,
"currency": "USD",
"dateCreate": "2025-10-30T11:19:38+02:00",
"dateDocument": null,
"dateModify": "2025-10-30T11:19:38+02:00",
"dateStatus": "2025-10-30T11:19:38+02:00",
"docNumber": "IN-00042",
"docType": "A",
"id": 11,
"modifiedBy": 29,
"responsibleId": 29,
"siteId": "s1",
"status": "N",
"statusBy": null,
"title": "Receipt from Supplier-1",
"total": null
}
},
"time": {
"start": 1761805178,
"finish": 1761805178.991429,
"duration": 0.9914290904998779,
"processing": 0,
"date_start": "2025-10-30T09:19:38+02:00",
"date_finish": "2025-10-30T09:19:38+02:00",
"operating_reset_at": 1761805778,
"operating": 0.2595658302307129
}
}
The document is created with status N — draft. To process the document, use the method catalog.document.conduct or catalog.document.conductList.
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
document |
Object with data of the created document |
|
time |
Information about the request execution time |
Error Handling
|
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 |
HTTP code: 400
{
"error": "0",
"error_description": "DOC_TYPE isn't available"
}
Possible Error Codes
|
Code |
Description |
Value |
|
|
Insufficient permissions to save the document |
The user does not have permission to create the required document type |
|
|
DOC_TYPE isn't available |
An invalid document type was provided |
|
|
Inventory accounting is not available on your plan |
Inventory accounting is not available on your plan |
|
|
- |
Other internal errors when adding the document |
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 |