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:
documentgeneratorWho 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 |
Description |
|
fields* |
Set of numerator parameters (detailed description) |
Parameter fields
|
Name |
Description |
|
name* |
Name of the numerator |
|
template* |
Number template with the placeholder The placeholder Template examples:
|
|
settings |
Settings for the numerator generators (detailed description) |
Parameter settings
|
Name |
Description |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
Settings for sequential numbering (detailed description) |
Parameters Bitrix_Main_Numerator_Generator_SequentNumberGenerator
|
Name |
Description |
|
|
start |
Initial counter value. Default is |
|
|
step |
Counter increment step. Default is |
|
|
length |
Minimum length of the number. Default is |
|
|
padString |
Padding character on the left when Default is |
|
|
periodicBy |
Counter reset period:
|
|
|
timezone |
Timezone identifier for periodic reset, e.g., |
|
|
isDirectNumeration |
Direct numbering flag. Possible values:
Default is In the method response, the value is returned as |
|
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 -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
// 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 NumeratorAddResult = {
numerator: {
id: number
name: string
template: string
code: string | null
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: number
step: number
length: number
padString: string
periodicBy: string
timezone: string
isDirectNumeration: boolean
}
}
}
}
try {
const response = await $b24.actions.v2.call.make<NumeratorAddResult>({
method: 'documentgenerator.numerator.add',
params: {
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,
},
},
},
},
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 addNumerator() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.numerator.add',
params: {
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,
},
},
},
},
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', addNumerator)
</script>
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 |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
numerator |
Created numerator (detailed description) |
Object numerator
|
Name |
Description |
|
id |
Identifier of the numerator |
|
name |
Name of the numerator |
|
template |
Number template |
|
code |
Symbolic code of the numerator. Can be |
|
settings |
Settings for the numerator generators (detailed description) |
Object settings
|
Name |
Description |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
Settings for sequential numbering (detailed description) |
Object Bitrix_Main_Numerator_Generator_SequentNumberGenerator
|
Name |
Description |
|
start |
Initial counter value |
|
step |
Counter increment step |
|
length |
Minimum length of the number |
|
padString |
Padding character on the left when |
|
periodicBy |
Counter reset period |
|
timezone |
Timezone identifier for periodic reset |
|
isDirectNumeration |
Direct numbering flag |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Empty required fields: name, template"
}
|
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 |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Empty required fields: name, template |
Required fields |
|
|
|
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 |
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 |