Add Document Generator Numerator: 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: documentgenerator

Who 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
type

Description

fields*
object

Set of numerator parameters (detailed description)

Parameter fields

Name
type

Description

name*
string

Name of the numerator

template*
string

Number template with the placeholder {NUMBER}.

The placeholder {NUMBER} should be specified in curly braces. When generating a document, the placeholder is replaced with the next counter value according to the settings.

Template examples:

  • {NUMBER}1000
  • INV-{NUMBER}INV-1000
  • DG/{NUMBER}/2026DG/1000/2026

settings
object

Settings for the numerator generators (detailed description)

Parameter settings

Name
type

Description

Bitrix_Main_Numerator_Generator_SequentNumberGenerator
object

Settings for sequential numbering (detailed description)

Parameters Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Name
type

Description

start
integer

Initial counter value.

Default is 1

step
integer

Counter increment step.

Default is 1

length
integer

Minimum length of the number.

Default is 0

padString
string

Padding character on the left when length > 0.

Default is 0

periodicBy
string

Counter reset period:

  • '' — no reset
  • day — daily
  • month — monthly
  • year — yearly

timezone
string

Timezone identifier for periodic reset, e.g., Europe/Berlin

isDirectNumeration
boolean

Direct numbering flag.

Possible values:

  • 0 — disabled
  • 1 — enabled

Default is 0.

In the method response, the value is returned as true | false

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>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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": "",
                            "timezone": "Europe/Berlin",
                        },
                    },
                },
            ).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(
                '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);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.numerator.add", b24.Params{
        	"fields": b24.Params{
        		"name":     "REST Invoice Numerator",
        		"template": "INV-{NUMBER}",
        		"settings": b24.Params{
        			"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": b24.Params{
        				"start":              1000,
        				"step":               5,
        				"length":             8,
        				"padString":          "0",
        				"periodicBy":         "year",
        				"timezone":           "Europe/Berlin",
        				"isDirectNumeration": 0,
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("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 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
type

Description

result
object

Root element of the response (detailed description)

time
time

Information about the request execution time

Object result

Name
type

Description

numerator
object

Created numerator (detailed description)

Object numerator

Name
type

Description

id
integer

Identifier of the numerator

name
string

Name of the numerator

template
string

Number template

code
string

Symbolic code of the numerator. Can be null

settings
object

Settings for the numerator generators (detailed description)

Object settings

Name
type

Description

Bitrix_Main_Numerator_Generator_SequentNumberGenerator
object

Settings for sequential numbering (detailed description)

Object Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Name
type

Description

start
integer

Initial counter value

step
integer

Counter increment step

length
integer

Minimum length of the number

padString
string

Padding character on the left when length > 0

periodicBy
string

Counter reset period

timezone
string

Timezone identifier for periodic reset

isDirectNumeration
boolean

Direct numbering flag

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Empty required fields: name, template"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

100

Could not find value for parameter

Required parameter fields not provided

400

0

Empty required fields: name, template

Required fields name and template not provided within fields

400

0

You do not have permissions to modify templates

Insufficient permissions to modify document generator templates

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning