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

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: 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 -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
        
// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type GetFieldsResult = {
          documentFields: Record<string, FieldInfo>
        }
        
        type FieldInfo = {
          title?: string
          value?: string
          default?: string
          group?: string[]
          chain?: string | unknown[]
          required?: 'Y' | 'N'
          type?: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<GetFieldsResult>({
            method: 'documentgenerator.document.getfields',
            params: {
              id: 51,
              values: {
                DocumentNumber: 'DG-2026-001',
                CurrentDate: '2026-03-18T00:00:00+03:00',
                ClientName: 'LLC Romashka',
                ClientPhone: '+49 999 123-45-67',
                Total: '51000',
                Comment: 'Payment within 5 business days after signing',
                UserName: 'Ivan Petrov',
              },
            },
            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('Document fields:', Object.keys(result.documentFields))
          }
        } 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 getDocumentFields() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'documentgenerator.document.getfields',
                params: {
                  id: 51,
                  values: {
                    DocumentNumber: 'DG-2026-001',
                    CurrentDate: '2026-03-18T00:00:00+03:00',
                    ClientName: 'LLC Romashka',
                    ClientPhone: '+49 999 123-45-67',
                    Total: '51000',
                    Comment: 'Payment within 5 business days after signing',
                    UserName: 'Ivan Petrov',
                  },
                },
                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('Document fields:', Object.keys(result.documentFields))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDocumentFields)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.documentgenerator.document.getfields(
                bitrix_id=51,
                values={
                    "DocumentNumber": "DG-2026-001",
                    "CurrentDate": "2026-03-18T00:00:00+03:00",
                    "ClientName": "Müller GmbH",
                    "ClientPhone": "+49 999 123-45-67",
                    "Total": "125000",
                    "Comment": "Payment within 5 business days after signing",
                    "UserName": "Klaus Weber",
                },
            ).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(
                '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);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.document.getfields", b24.Params{
        	"id": 51,
        	"values": b24.Params{
        		"DocumentNumber": "DG-2026-001",
        		"CurrentDate":    "2026-03-18T00:00:00+03:00",
        		"ClientName":     "Ltd. Chamomile",
        		"ClientPhone":    "+49 999 123-45-67",
        		"Total":          "51000",
        		"Comment":        "Payment within 5 business days after signing",
        		"UserName":       "John Smith",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("documentgenerator.document.getfields: %w", err)
        }
        
        // The method wraps the response in an object with the "documentFields" key.
        raw, ok := b24.Unwrap(res.Result, "documentFields")
        if !ok {
        	return fmt.Errorf("no documentFields key in the response")
        }
        
        fmt.Printf("%s\n", raw)
        

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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: 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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