Add Document Generator Numerator: documentgenerator.numerator.add

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: documentgenerator

Who can execute the method: a user with permission to modify document generator templates

The method documentgenerator.numerator.add creates a document numerator.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Set of numerator parameters (detailed description)

Parameter fields

Name `type`	Description
name* `string`	Name of the numerator
template* `string`	Number template with the placeholder `{NUMBER}`. The placeholder `{NUMBER}` should be specified in curly braces. When generating a document, the placeholder is replaced with the next counter value according to the `settings`. Template examples: `{NUMBER}` → `1000` `INV-{NUMBER}` → `INV-1000` `DG/{NUMBER}/2026` → `DG/1000/2026`
settings `object`	Settings for the numerator generators (detailed description)

Parameter settings

Name `type`	Description
Bitrix_Main_Numerator_Generator_SequentNumberGenerator `object`	Settings for sequential numbering (detailed description)

Parameters Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Name `type`	Description
start `integer`	Initial counter value. Default is `1`
step `integer`	Counter increment step. Default is `1`
length `integer`	Minimum length of the number. Default is `0`
padString `string`	Padding character on the left when `length > 0`. Default is `0`
periodicBy `string`	Counter reset period: `''` — no reset `day` — daily `month` — monthly `year` — yearly
timezone `string`	Timezone identifier for periodic reset, e.g., `Europe/Berlin`
isDirectNumeration `boolean`	Direct numbering flag. Possible values: `0` — disabled `1` — enabled Default is `0`. In the method response, the value is returned as `true`	`false`

Code Examples

How to Use Examples in Documentation

Example of creating a numerator:

name — REST Invoice Numerator
template — INV-{NUMBER}
starting value — 1000
step — 5
minimum number length — 8
padding character — 0
reset number — yearly year
timezone — Europe/Berlin
direct numbering — 0

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "name": "REST Invoice Numerator",
              "template": "INV-{NUMBER}",
              "settings": {
                "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                  "start": 1000,
                  "step": 5,
                  "length": 8,
                  "padString": "0",
                  "periodicBy": "year",
                  "timezone": "Europe/Berlin",
                  "isDirectNumeration": 0
                }
              }
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.numerator.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "name": "REST Invoice Numerator",
              "template": "INV-{NUMBER}",
              "settings": {
                "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                  "start": 1000,
                  "step": 5,
                  "length": 8,
                  "padString": "0",
                  "periodicBy": "year",
                  "timezone": "Europe/Berlin",
                  "isDirectNumeration": 0
                }
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.numerator.add',
                {
                    fields: {
                        name: 'REST Invoice Numerator',
                        template: 'INV-{NUMBER}',
                        settings: {
                            Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                                start: 1000,
                                step: 5,
                                length: 8,
                                padString: '0',
                                periodicBy: 'year',
                                timezone: 'Europe/Berlin',
                                isDirectNumeration: 0
                            }
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.numerator.add',
                [
                    'fields' => [
                        'name' => 'REST Invoice Numerator',
                        'template' => 'INV-{NUMBER}',
                        'settings' => [
                            'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                                'start' => 1000,
                                'step' => 5,
                                'length' => 8,
                                'padString' => '0',
                                'periodicBy' => 'year',
                                'timezone' => 'Europe/Berlin',
                                'isDirectNumeration' => 0,
                            ],
                        ],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.numerator.add',
            {
                fields: {
                    name: 'REST Invoice Numerator',
                    template: 'INV-{NUMBER}',
                    settings: {
                        Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                            start: 1000,
                            step: 5,
                            length: 8,
                            padString: '0',
                            periodicBy: 'year',
                            timezone: 'Europe/Berlin',
                            isDirectNumeration: 0
                        }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.numerator.add',
            [
                'fields' => [
                    'name' => 'REST Invoice Numerator',
                    'template' => 'INV-{NUMBER}',
                    'settings' => [
                        'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                            'start' => 1000,
                            'step' => 5,
                            'length' => 8,
                            'padString' => '0',
                            'periodicBy' => 'year',
                            'timezone' => 'Europe/Berlin',
                            'isDirectNumeration' => 0,
                        ],
                    ],
                ],
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "numerator": {
                    "name": "REST Invoice Numerator",
                    "template": "INV-{NUMBER}",
                    "id": 55,
                    "code": null,
                    "settings": {
                        "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                            "start": 1000,
                            "step": 5,
                            "length": 8,
                            "padString": "0",
                            "periodicBy": "year",
                            "timezone": "Europe/Berlin",
                            "isDirectNumeration": false
                        }
                    }
                }
            },
            "time": {
                "start": 1774360939,
                "finish": 1774360939.968711,
                "duration": 0.9687108993530273,
                "processing": 0,
                "date_start": "2026-03-24T17:02:19+02:00",
                "date_finish": "2026-03-24T17:02:19+02:00",
                "operating_reset_at": 1774361539,
                "operating": 0
            }
        }

Returned Data

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

Object result

Name `type`	Description
numerator `object`	Created numerator (detailed description)

Object numerator

Name `type`	Description
id `integer`	Identifier of the numerator
name `string`	Name of the numerator
template `string`	Number template
code `string`	Symbolic code of the numerator. Can be `null`
settings `object`	Settings for the numerator generators (detailed description)

Object settings

Name `type`	Description
Bitrix_Main_Numerator_Generator_SequentNumberGenerator `object`	Settings for sequential numbering (detailed description)

Object Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Name `type`	Description
start `integer`	Initial counter value
step `integer`	Counter increment step
length `integer`	Minimum length of the number
padString `string`	Padding character on the left when `length > 0`
periodicBy `string`	Counter reset period
timezone `string`	Timezone identifier for periodic reset
isDirectNumeration `boolean`	Direct numbering flag

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Empty required fields: name, template"
        }

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`	Could not find value for parameter	Required parameter `fields` not provided
`400`	`0`	Empty required fields: name, template	Required fields `name` and `template` not provided within `fields`
`400`	`0`	You do not have permissions to modify templates	Insufficient permissions to modify document generator templates

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

Overview of Methods

Update Numbering Rule

Add Document Generator Numerator: documentgenerator.numerator.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter settingsParameter settings

Parameters Bitrix_Main_Numerator_Generator_SequentNumberGeneratorParameters Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object numeratorObject numerator

Object settingsObject settings

Object Bitrix_Main_Numerator_Generator_SequentNumberGeneratorObject Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning