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:
crmWho 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 |
Description |
|
fields* |
An object with numerator parameters in the following format:
where:
The list of fields is below |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
name* |
The name of the numerator |
|
template* |
The number template, for example |
|
settings |
Generator settings. Parameter descriptions are below. |
Parameter Settings
|
Name |
Description |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
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 resetday— dailymonth— monthlyyear— yearly ||
|| timezone
string| The timezone identifier for periodic reset, for exampleEurope/Berlin||
|| isDirectNumeration
boolean| Indicator of direct numbering. Default isfalse||
|#
Code Examples
How to Use Examples in Documentation
Example of creating a numerator:
- name — REST Enumerator
- template —
{NUMBER} - starting number — from
1, step1
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"REST Enumerator","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 Enumerator","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
// 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 | null
timezone: string | null
isDirectNumeration: boolean
}
}
}
}
try {
const response = await $b24.actions.v2.call.make<NumeratorAddResult>({
method: 'crm.documentgenerator.numerator.add',
params: {
fields: {
name: 'Numerator from REST',
template: '{NUMBER}',
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: 1,
step: 1,
length: 6,
padString: '0',
periodicBy: '',
timezone: '',
isDirectNumeration: false,
},
},
},
},
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('New numerator created:', result.numerator.id, result.numerator.name)
}
} 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: 'crm.documentgenerator.numerator.add',
params: {
fields: {
name: 'Numerator from REST',
template: '{NUMBER}',
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: 1,
step: 1,
length: 6,
padString: '0',
periodicBy: '',
timezone: '',
isDirectNumeration: false,
},
},
},
},
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('New numerator created:', result.numerator.id, result.numerator.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addNumerator)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.numerator.add',
[
'fields' => [
'name' => 'REST Enumerator',
'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();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.numerator.add(
fields={
"name": "REST Enumerator",
"template": "{NUMBER}",
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 1,
"step": 1,
"length": 6,
"padString": "0",
"periodicBy": "",
"timezone": "",
"isDirectNumeration": False,
},
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
BX24.callMethod(
'crm.documentgenerator.numerator.add',
{
fields: {
name: 'REST Enumerator',
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 Enumerator',
'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 Enumerator",
"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+03:00",
"date_finish": "2026-03-17T11:09:17+03:00",
"operating_reset_at": 1773735557,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains the |
|
time |
Information about the request execution time |
Numerator Type
|
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. Can be |
|
settings |
Saved settings for sequential numbering of type |
Settings Type
|
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 left padding character |
|
periodicBy |
The reset period for the counter: |
|
timezone |
The timezone identifier for periodic reset. Can be |
|
isDirectNumeration |
Indicator of direct numbering |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Empty required fields: 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
|
Code |
Description |
Value |
|
|
Invalid value {...} to match with parameter {fields}. Should be value of type array. |
The |
|
|
|
Required fields are not provided |
|
Empty value |
|
Insufficient permissions to modify document generator templates |
|
Empty value |
|
The |
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 |