Get Description of Fields for Inventory Document catalog.document.getFields
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
catalogWho can execute the method: user with the "View product catalog" access permission
The method catalog.document.getFields returns the description of fields for the inventory document.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.getFields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.getFields
try
{
const response = await $b24.callMethod(
'catalog.document.getFields',
{}
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.document.getFields',
[]
);
$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 getting document fields: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.getFields',
{},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Code: 200
{
"result": {
"document": {
"commentary": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"createdBy": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"currency": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "char"
},
"dateCreate": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": false,
"type": "datetime"
},
"dateDocument": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "datetime"
},
"dateModify": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "datetime"
},
"dateStatus": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"docNumber": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"docType": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "char"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"modifiedBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"responsibleId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": true,
"type": "integer"
},
"siteId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"status": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"statusBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"title": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"total": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "double"
}
}
},
"time": {
"start": 1761727898,
"finish": 1761727898.554004,
"duration": 0.5540039539337158,
"processing": 0,
"date_start": "2025-10-29T11:51:38+01:00",
"date_finish": "2025-10-29T11:51:38+01:00",
"operating_reset_at": 1761728498,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
document |
Object with the description of fields for the inventory document |
|
time |
Information about the execution time of the request |
Error Handling
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
HTTP Code: 400
{
"error": "0",
"error_description": "Insufficient permissions to save the document"
}
Possible Error Codes
|
Code |
Description |
Value |
|
|
Insufficient permissions to save the document |
User does not have view permission |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Get a List of Warehouse Accounting Documents catalog.document.list
- Create Inventory Document catalog.document.add
- Update Warehouse Accounting Document catalog.document.update