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:
documentgeneratorWho 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 |
Description |
|
id* |
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 -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
// 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 NumeratorGetResult = {
numerator: {
id: string
name: string
template: string
code: string | null
settings: Record<string, {
start: number
step: number
length: number
padString: string
periodicBy: string
timezone: string
isDirectNumeration: boolean
}>
}
}
try {
const response = await $b24.actions.v2.call.make<NumeratorGetResult>({
method: 'documentgenerator.numerator.get',
params: {
id: 55,
},
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(result.numerator.id, result.numerator.name, result.numerator.template)
}
} 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 getNumerator() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.numerator.get',
params: {
id: 55,
},
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(result.numerator.id, result.numerator.name, result.numerator.template)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getNumerator)
</script>
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 |
Description |
|
result |
The root element of the response (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
numerator |
The numerator data (detailed description) |
Numerator Object
|
Name |
Description |
|
id |
The identifier of the numerator |
|
name |
The name of the numerator |
|
template |
The number template |
|
code |
The symbolic code of the numerator. It can be |
|
settings |
The settings of the numerator generators (detailed description) |
Settings Object
|
Name |
Description |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
Settings for sequential numbering (detailed description) |
Bitrix_Main_Numerator_Generator_SequentNumberGenerator Object
|
Name |
Description |
|
start |
The initial value of the counter |
|
step |
The increment step of the counter |
|
length |
The minimum length of the number |
|
padString |
The padding character on the left when |
|
periodicBy |
The reset period of the counter |
|
timezone |
The timezone identifier for periodic reset |
|
isDirectNumeration |
The indicator of direct numbering |
Error Handling
HTTP Status: 400
{
"error": "DOCGEN_ACCESS_ERROR",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
|
Bitrix\Main\Numerator\Numerator constructor must be public |
Required parameter |
|
|
|
Could not construct parameter |
An invalid or non-existent numerator identifier was provided |
|
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |