Update the Numerator crm.documentgenerator.numerator.update

Scope: crm

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

The method crm.documentgenerator.numerator.update updates an existing numerator.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the numerator

fields*
object

Object with fields to update in the 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`	Name of the numerator
template `string`	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`	Initial value of the counter. Default is `1`
step `integer`	Step for increasing the counter. 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, for example `Europe/Berlin`
isDirectNumeration `boolean`	Direct numbering flag. Default is `false`

Code Examples

How to Use Examples in Documentation

Example of updating a numerator:

new template — INV-{NUMBER}
start of the sequence — 100
step — 1

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":45,"fields":{"name":"Numerator from REST (updated)","template":"INV-{NUMBER}","settings":{"Bitrix_Main_Numerator_Generator_SequentNumberGenerator":{"start":100,"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.update

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.numerator.update',
        		{
        			id: 45,
        			fields: {
        				name: 'Numerator from REST (updated)',
        				template: 'INV-{NUMBER}',
        				settings: {
        					Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
        						start: 100,
        						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.update',
                    [
                        'id' => 45,
                        'fields' => [
                            'name' => 'Numerator from REST (updated)',
                            'template' => 'INV-{NUMBER}',
                            'settings' => [
                                'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                                    'start' => 100,
                                    '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 updating numerator: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.numerator.update',
            {
                id: 45,
                fields: {
                    name: 'Numerator from REST (updated)',
                    template: 'INV-{NUMBER}',
                    settings: {
                        Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                            start: 100,
                            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.update',
            [
                'id' => 45,
                'fields' => [
                    'name' => 'Numerator from REST (updated)',
                    'template' => 'INV-{NUMBER}',
                    'settings' => [
                        'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                            'start' => 100,
                            'step' => 1,
                            'length' => 6,
                            'padString' => '0',
                            'periodicBy' => '',
                            'timezone' => '',
                            'isDirectNumeration' => false,
                        ],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "name": "Numerator from REST (updated)",
                "template": "INV-{NUMBER}",
                "id": "45",
                "code": null,
                "settings": {
                    "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                        "start": 100,
                        "step": 1,
                        "length": 0,
                        "padString": "0",
                        "periodicBy": null,
                        "timezone": null,
                        "isDirectNumeration": false
                    }
                }
            },
            "time": {
                "start": 1773743992,
                "finish": 1773743992.664487,
                "duration": 0.6644868850708008,
                "processing": 0,
                "date_start": "2026-03-17T13:39:52+01:00",
                "date_finish": "2026-03-17T13:39:52+01:00",
                "operating_reset_at": 1773744592,
                "operating": 0
            }
        }

Returned Data

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

Type result

Name `type`	Description
id `string`	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`	Saved generator settings

Error Handling

HTTP Status: 400

{
            "error": "100",
            "error_description": "Could not construct parameter {numerator}"
        }

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`	`Could not find value for parameter {fields}`	Required parameter `fields` not provided
`100`	`Bitrix\Main\Numerator\Numerator constructor must be is public`	Internal error while creating the numerator object
`100`	Invalid value {...} to match with parameter {fields}. Should be value of type array.	Parameter `fields` not passed as an array/object
`100`	`Could not construct parameter {numerator}`	Numerator with the specified `id` not found
`DOCGEN_ACCESS_ERROR`	`Access denied`	No access to the numerator. The method only updates numerators created via REST
`Empty value`	`You do not have permissions to modify templates`	Insufficient rights 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 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

Add a new numberer

Get information about a numberer by Id

Update the Numerator crm.documentgenerator.numerator.update

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 resultType result

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning