Add a New Numerator crm.documentgenerator.numerator.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to 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 of Bitrix_Main_Numerator_Generator_SequentNumberGenerator
|
Name |
Description |
|
start |
The initial value of the counter. Default is |
|
step |
The increment step of the counter. Default is |
|
length |
The minimum length of the number. Default is |
|
padString |
The left padding character when |
|
periodicBy |
The reset period for the counter:
|
|
timezone |
The timezone identifier for periodic reset, for example |
|
isDirectNumeration |
Indicator of direct numbering. Default is |
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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();
}
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.documentgenerator.numerator.add", b24.Params{
"fields": b24.Params{
"name": "REST Enumerator",
"template": "{NUMBER}",
"settings": b24.Params{
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": b24.Params{
"start": 1,
"step": 1,
"length": 6,
"padString": "0",
"periodicBy": "",
"timezone": "",
"isDirectNumeration": false,
},
},
},
})
if err != nil {
return fmt.Errorf("crm.documentgenerator.numerator.add: %w", err)
}
// The method wraps the response in an object with the "numerator" key.
raw, ok := b24.Unwrap(res.Result, "numerator")
if !ok {
return fmt.Errorf("no numerator key in the response")
}
var item struct {
Name string `json:"name"`
Template string `json:"template"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Name, item.Template)
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |