Add a New Numerator crm.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: crm

Who can execute the method: a user with "modify" access permission for document generator templates

The method crm.documentgenerator.numerator.add creates a new numerator.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object with numerator parameters in the following format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            "...": "..."
        }

where:

field_n — field name
value_n — field value

The list of fields is below

Parameter fields

Required parameters are marked with *

Name `type`	Description
name* `string`	The name of the numerator
template* `string`	The number template, for example `{NUMBER}`
settings `object`	Generator settings. Parameter descriptions are below.

Parameter settings

Name `type`	Description
Bitrix_Main_Numerator_Generator_SequentNumberGenerator `object`	Settings for sequential numbering. Parameter descriptions are below

Parameters Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Name `type`	Description
start `integer`	The initial value of the counter. Default is `1`
step `integer`	The increment step of the counter. Default is `1`
length `integer`	The minimum length of the number. Default is `0`
padString `string`	The left padding character when `length > 0`. Default is `'0'`
periodicBy `string`	The reset period for the counter: `''` — no reset `day` — daily `month` — monthly `year` — yearly
timezone `string`	The timezone identifier for periodic reset, for example `Europe/Berlin`
isDirectNumeration `boolean`	Indicator of direct numbering. Default is `false`

Code Examples

How to Use Examples in Documentation

Example of creating a numerator:

name — REST Numerator
template — {NUMBER}
starting number — from 1, step 1

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 Numerator","template":"{NUMBER}","settings":{"Bitrix_Main_Numerator_Generator_SequentNumberGenerator":{"start":1,"step":1,"length":6,"padString":"0","periodicBy":"","timezone":"","isDirectNumeration":false}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.numerator.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"REST Numerator","template":"{NUMBER}","settings":{"Bitrix_Main_Numerator_Generator_SequentNumberGenerator":{"start":1,"step":1,"length":6,"padString":"0","periodicBy":"","timezone":"","isDirectNumeration":false}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.numerator.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.numerator.add',
        		{
        			fields: {
        				name: 'REST Numerator',
        				template: '{NUMBER}',
        				settings: {
        					Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
        						start: 1,
        						step: 1,
        						length: 6,
        						padString: '0',
        						periodicBy: '',
        						timezone: '',
        						isDirectNumeration: false,
        					},
        				},
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.numerator.add',
                    [
                        'fields' => [
                            'name' => 'REST Numerator',
                            'template' => '{NUMBER}',
                            'settings' => [
                                'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                                    'start' => 1,
                                    'step' => 1,
                                    'length' => 6,
                                    'padString' => '0',
                                    'periodicBy' => '',
                                    'timezone' => '',
                                    'isDirectNumeration' => false,
                                ],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding numerator: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.numerator.add',
            {
                fields: {
                    name: 'REST Numerator',
                    template: '{NUMBER}',
                    settings: {
                        Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                            start: 1,
                            step: 1,
                            length: 6,
                            padString: '0',
                            periodicBy: '',
                            timezone: '',
                            isDirectNumeration: false,
                        },
                    },
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.numerator.add',
            [
                'fields' => [
                    'name' => 'REST Numerator',
                    'template' => '{NUMBER}',
                    'settings' => [
                        'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                            'start' => 1,
                            'step' => 1,
                            'length' => 6,
                            'padString' => '0',
                            'periodicBy' => '',
                            'timezone' => '',
                            'isDirectNumeration' => false,
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "numerator": {
                    "name": "REST Numerator",
                    "template": "{NUMBER}",
                    "id": 45,
                    "code": null,
                    "settings": {
                        "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                            "start": 1,
                            "step": 1,
                            "length": 0,
                            "padString": "0",
                            "periodicBy": null,
                            "timezone": null,
                            "isDirectNumeration": false
                        }
                    }
                }
            },
            "time": {
                "start": 1773734957,
                "finish": 1773734957.389446,
                "duration": 0.3894460201263428,
                "processing": 0,
                "date_start": "2026-03-17T11:09:17+01:00",
                "date_finish": "2026-03-17T11:09:17+01:00",
                "operating_reset_at": 1773735557,
                "operating": 0
            }
        }

Returned Data

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

Type numerator

Name `type`	Description
id `integer`	The identifier of the numerator
name `string`	The name of the numerator
template `string`	The number template
code `string`	The symbolic code of the numerator. Can be `null`
settings `object`	Saved settings for sequential numbering of type `settings`

Type settings

Name `type`	Description
start `integer`	The initial value of the counter
step `integer`	The increment step of the counter
length `integer`	The minimum length of the number
padString `string`	The left padding character
periodicBy `string`	The reset period for the counter: `null`, `day`, `month`, or `year`
timezone `string`	The timezone identifier for periodic reset. Can be `null`
isDirectNumeration `boolean`	Indicator of direct numbering

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Empty required fields: 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

Code	Description	Value
`100`	Invalid value {...} to match with parameter {fields}. Should be value of type array.	The `fields` parameter was not passed as an array/object
`0`	`Empty required fields: ...`	Required fields are missing
`Empty value`	`You do not have permissions to modify templates`	Insufficient permissions to modify document generator templates
`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

Overview of methods

Modify an existing numberer

Add a New Numerator crm.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

Type numeratorType numerator

Type settingsType settings

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning