Get Numerator by ID documentgenerator.numerator.get

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.get returns the numerator data by its ID.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

The identifier of the numerator.

You can obtain the identifier after creating a numerator or by using the method to get the list of numerators

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":55}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.numerator.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":55,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.get

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.numerator.get',
                {
                    id: 55
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.numerator.get',
                [
                    'id' => 55,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.numerator.get',
            {
                id: 55
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.numerator.get',
            [
                'id' => 55,
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "numerator": {
                    "name": "REST Invoice Numerator Updated",
                    "template": "INV-UPD-{NUMBER}",
                    "id": "55",
                    "code": null,
                    "settings": {
                        "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                            "start": 2000,
                            "step": 10,
                            "length": 8,
                            "padString": "0",
                            "periodicBy": "year",
                            "timezone": "Europe/Berlin",
                            "isDirectNumeration": false
                        }
                    }
                }
            },
            "time": {
                "start": 1774363151,
                "finish": 1774363151.551318,
                "duration": 0.5513179302215576,
                "processing": 0,
                "date_start": "2026-03-24T17:39:11+01:00",
                "date_finish": "2026-03-24T17:39:11+01:00",
                "operating_reset_at": 1774363751,
                "operating": 0
            }
        }

Returned Data

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

Result Object

Name `type`	Description
numerator `object`	The numerator data (detailed description)

Numerator Object

Name `type`	Description
id `string`	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. It can be `null`
settings `object`	The settings of the numerator generators (detailed description)

Settings Object

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

Bitrix_Main_Numerator_Generator_SequentNumberGenerator Object

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 padding character on the left when `length > 0`
periodicBy `string`	The reset period of the counter
timezone `string`	The timezone identifier for periodic reset
isDirectNumeration `boolean`	The indicator of direct numbering

Error Handling

HTTP Status: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "error_description": "Access denied"
        }

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\Main\Numerator\Numerator constructor must be public	Required parameter `id` is missing
`400`	`100`	Could not construct parameter	An invalid or non-existent numerator identifier was provided
`400`	`0`	You do not have permissions to modify templates	Insufficient rights 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

Update Numbering Rule

Get List of Numbering Rules

Get Numerator by ID documentgenerator.numerator.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Numerator ObjectNumerator Object

Settings ObjectSettings Object

Bitrix_Main_Numerator_Generator_SequentNumberGenerator ObjectBitrix_Main_Numerator_Generator_SequentNumberGenerator Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning