Get Document Fields crm.documentgenerator.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: crm

Who can execute the method: a user with "edit" access permission for document generator documents

The method crm.documentgenerator.document.getfields returns a detail form of the fields of an already created document: which fields are available, their current values, default values, and service indicators.

Method Parameters

Required parameters are marked with *

Name
type

Description

id^*
integer

Document identifier

values
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }

where:

field_n — document field code
value_n — field value

values are temporary substitutions over the current document values. The method takes the document data, applies values, and recalculates the fields.

This allows checking the result without changing the document itself. For example, if you pass values.DocumentNumber = "2026-001", the response will return the DocumentNumber field with the value 2026-001. If values are not passed, the current value of the document will be returned for the same field, for instance, 1.

If values are not provided, the method will return the detail form of the fields based on the current document data and template logic

Parameter values

The composition of the keys in values depends on the template used to create the document, so it may vary across different documents.

Name `type`	Description
DocumentNumber `string`	Document number
DocumentCreateTime `string`	Generation date
DocumentTitle `string`	Document title
ClientPhone `string`	Client phone
ClientEmail `string`	Client email
ProductsProductName `array` \| `string`	Product name
ProductsProductQuantity `array` \| `string`	Quantity
TotalSum `string`	Total amount

Code Examples

How to Use Examples in Documentation

Example of retrieving document fields, where:

document identifier — 101
field value DocumentNumber — 2026-001

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":101,"values":{"DocumentNumber":"2026-001"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.getfields

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":101,"values":{"DocumentNumber":"2026-001"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.getfields

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.getfields',
        		{
        			id: 101,
        			values: {
        				DocumentNumber: '2026-001',
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.getfields',
                    [
                        'id' => 101,
                        'values' => [
                            'DocumentNumber' => '2026-001',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting document fields: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.getfields',
            {
                id: 101,
                values: {
                    DocumentNumber: '2026-001',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.getfields',
            [
                'id' => 101,
                'values' => [
                    'DocumentNumber' => '2026-001',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "documentFields": {
                    "DocumentNumber": {
                        "title": "Number",
                        "value": "2026-001",
                        "required": "Y",
                        "group": [
                            "Document"
                        ],
                        "chain": "this.DOCUMENT.DOCUMENT_NUMBER",
                        "default": "2026-001"
                    },
                    "MyCompanyUfLogo": {
                        "title": "Logo",
                        "value": null,
                        "type": "IMAGE",
                        "group": [
                            "Document",
                            "My Company"
                        ],
                        "chain": "this.SOURCE.MY_COMPANY.UF_LOGO",
                        "default": null
                    },
                    "MY_COMPANY": {
                        "title": "My Company",
                        "value": [
                            {
                                "value": "340",
                                "title": "Fortune Wheel",
                                "selected": true
                            },
                            {
                                "value": "358",
                                "title": "Bitrix-Development",
                                "selected": false
                            }
                        ],
                        "group": [
                            "Document",
                            "My Company"
                        ]
                    }
                }
            },
            "time": {
                "start": 1773909500,
                "finish": 1773909500.192341,
                "duration": 0.19234108924865723,
                "processing": 0,
                "date_start": "2026-03-19T11:38:20+02:00",
                "date_finish": "2026-03-19T11:38:20+02:00",
                "operating_reset_at": 1773910100,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains the object `result`
time `time`	Information about the request execution time

Type result

Name `type`	Description
documentFields `object`	Object of document fields, where the key is the field code and the value is the structure `documentField`

Type documentField

Name `type`	Description
title `string`	Field name
value `string` \| `array` \| `null`	Current field value
default `string` \| `null`	Default field value
required `char`	Field mandatory indicator: `Y` or `N`
type `string`	Field type, e.g., `IMAGE`
group `array`	Groups to which the field belongs
chain `string` \| `array`	Path of the field in the data provider, e.g., `this.SOURCE.MY_COMPANY.UF_LOGO`
format `object`	Field formatting parameters, e.g., `{"currencyId":"EUR","withZeros":true}`
options `object`	Additional field parameters, e.g., `{"isArray":true}`
hideRow `char`	Service indicator for hiding the row: `Y` or `N`

Error Handling

HTTP Status: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "error_description": "Access denied"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`100`	Bitrix\DocumentGenerator\Document constructor must be is public	Required parameter `id` not provided
`DOCGEN_ACCESS_ERROR`	Access denied	No access to the document or insufficient rights to work with document generator documents
`0`	Document not found	Document with the specified `id` not found or unavailable
`Empty value`	You do not have permissions to modify documents	Insufficient rights to modify document generator documents
`Empty value`	Module documentgenerator is not installed	The `documentgenerator` module is unavailable

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	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
`500`	`PORTAL_DELETED` Portal was deleted	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

Upload Generated Document and Attach it to Specified CRM Entity

Overview of Events

Get Document Fields crm.documentgenerator.document.getfields

Method ParametersMethod Parameters

Parameter valuesParameter values

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Type documentFieldType documentField

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning