Get the list of fields for the document documentgenerator.document.getfields

Scope: documentgenerator

Who can execute the method: user with permission to modify documents

The method documentgenerator.document.getfields returns the fields of the document, along with their current and base values.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Document identifier.

You can obtain the document identifier after creating the document or by using the get document list method

values
object

Optional parameter.

Field values that the method temporarily substitutes before forming documentFields.

Use values to check in advance how the values will be interpreted and displayed when creating or updating the document.

If values is not provided, the method will return a structure of fields with current and base values

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":51,"values":{"DocumentNumber":"DG-2026-001","CurrentDate":"2026-03-18T00:00:00+02:00","ClientName":"Ltd. Chamomile","ClientPhone":"+1 999 123-45-67","Total":"51000","Comment":"Payment within 5 business days after signing","UserName":"John Smith"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.getfields

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":51,"values":{"DocumentNumber":"DG-2026-001","CurrentDate":"2026-03-18T00:00:00+02:00","ClientName":"Ltd. Chamomile","ClientPhone":"+1 999 123-45-67","Total":"51000","Comment":"Payment within 5 business days after signing","UserName":"John Smith"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.document.getfields

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.document.getfields',
                {
                    id: 51,
                    values: {
                        DocumentNumber: 'DG-2026-001',
                        CurrentDate: '2026-03-18T00:00:00+02:00',
                        ClientName: 'Ltd. Chamomile',
                        ClientPhone: '+1 999 123-45-67',
                        Total: '51000',
                        Comment: 'Payment within 5 business days after signing',
                        UserName: 'John Smith'
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.document.getfields',
                [
                    'id' => 51,
                    'values' => [
                        'DocumentNumber' => 'DG-2026-001',
                        'CurrentDate' => '2026-03-18T00:00:00+02:00',
                        'ClientName' => 'Ltd. Chamomile',
                        'ClientPhone' => '+1 999 123-45-67',
                        'Total' => '51000',
                        'Comment' => 'Payment within 5 business days after signing',
                        'UserName' => 'John Smith',
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.document.getfields',
            {
                id: 51,
                values: {
                    DocumentNumber: 'DG-2026-001',
                    CurrentDate: '2026-03-18T00:00:00+02:00',
                    ClientName: 'Ltd. Chamomile',
                    ClientPhone: '+1 999 123-45-67',
                    Total: '51000',
                    Comment: 'Payment within 5 business days after signing',
                    UserName: 'John Smith'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.document.getfields',
            [
                'id' => 51,
                'values' => [
                    'DocumentNumber' => 'DG-2026-001',
                    'CurrentDate' => '2026-03-18T00:00:00+02:00',
                    'ClientName' => 'Ltd. Chamomile',
                    'ClientPhone' => '+1 999 123-45-67',
                    'Total' => '51000',
                    'Comment' => 'Payment within 5 business days after signing',
                    'UserName' => 'John Smith',
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "documentFields": {
                    "DocumentNumber": {
                        "title": "Number",
                        "value": "DG-2026-001",
                        "required": "Y",
                        "group": [
                            "Document"
                        ],
                        "chain": "this.DOCUMENT.DOCUMENT_NUMBER",
                        "default": "DG-2026-001"
                    },
                    "CurrentDate": {
                        "value": "2026-03-18T00:00:00+02:00",
                        "default": ""
                    },
                    "ClientName": {
                        "value": "Ltd. Chamomile",
                        "default": ""
                    },
                    "ClientPhone": {
                        "value": "+1 999 123-45-67",
                        "default": ""
                    },
                    "Total": {
                        "value": "51000",
                        "default": ""
                    },
                    "Comment": {
                        "value": "Payment within 5 business days after signing",
                        "default": ""
                    },
                    "UserName": {
                        "value": "John Smith",
                        "default": ""
                    },
                    "DocumentTitle": {
                        "title": "Document Title",
                        "value": "SUPPLY_CONTRACT Template 1773843147554 DG-2026-001",
                        "group": [
                            "Document"
                        ],
                        "chain": [
                            {},
                            "getTitle"
                        ],
                        "required": "Y",
                        "default": "SUPPLY_CONTRACT Template 1773843147554 DG-2026-001"
                    }
                }
            },
            "time": {
                "start": 1773931419,
                "finish": 1773931419.57404,
                "duration": 0.5740399360656738,
                "processing": 0,
                "date_start": "2026-03-19T17:43:39+02:00",
                "date_finish": "2026-03-19T17:43:39+02:00",
                "operating_reset_at": 1773932019,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Result Object

Name `type`	Description
documentFields `object`	Set of document fields by field code (detailed description)

DocumentFields Object

Name `type`	Description
title `string`	Field name
value `string`	Current field value
default `string`	Base field value
group `array`	Field group in the template
chain `string` \| `array`	Field chain, if available. Can be a string (e.g., `this.DOCUMENT.DOCUMENT_NUMBER`) or an array (e.g., `[{}, "getTitle"]`)
required `string`	Field required indicator Possible values: `Y` — field is required `N` — field is optional
type `string`	Field type, if specified

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "You do not have permissions to view documents"
        }

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

Status	Code	Description	Value
`400`	`100`	Bitrix\DocumentGenerator\Document constructor must be public	Required parameter `id` not provided
`400`	`0`	Document not found	Document with the specified `id` not found
`400`	`0`	You do not have permissions to view documents	Insufficient rights to modify the document

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Enable/Disable Public Link for Document

Overview of Methods

Get the list of fields for the document documentgenerator.document.getfields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

DocumentFields ObjectDocumentFields Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning