Добавить нумератор documentgenerator.numerator.add

Scope: documentgenerator

Кто может выполнять метод: пользователь с правом на изменение шаблонов генератора документов

Метод documentgenerator.numerator.add создает нумератор документов.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
fields* `object`	Набор параметров нумератора (подробное описание)

Параметр fields

Название `тип`	Описание
name* `string`	Название нумератора
template* `string`	Шаблон номера с плейсхолдером `{NUMBER}`. Плейсхолдер `{NUMBER}` нужно указывать в фигурных скобках. При генерации документа плейсхолдер заменяется на следующее значение счетчика по настройкам `settings`. Примеры шаблонов: `{NUMBER}` → `1000` `INV-{NUMBER}` → `INV-1000` `DG/{NUMBER}/2026` → `DG/1000/2026`
settings `object`	Настройки генераторов нумератора (подробное описание)

Параметр settings

Название `тип`	Описание
Bitrix_Main_Numerator_Generator_SequentNumberGenerator `object`	Настройки последовательной нумерации (подробное описание)

Параметры Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Название `тип`	Описание
start `integer`	Начальное значение счетчика. По умолчанию `1`
step `integer`	Шаг увеличения счетчика. По умолчанию `1`
length `integer`	Минимальная длина номера. По умолчанию `0`
padString `string`	Символ добивки слева при `length > 0`. По умолчанию `0`
periodicBy `string`	Период сброса счетчика: `''` — без сброса `day` — ежедневно `month` — ежемесячно `year` — ежегодно
timezone `string`	Идентификатор часового пояса для периодического сброса, например `Europe/Moscow`
isDirectNumeration `boolean`	Признак прямой нумерации. Возможные значения: `0` — выключена `1` — включена По умолчанию `0`. В ответе метода значение возвращается в виде `true` \| `false`

Примеры кода

Как использовать примеры в документации

Пример создания нумератора:

название — REST Invoice Numerator
шаблон — INV-{NUMBER}
стартовое значение — 1000
шаг — 5
минимальная длина номера — 8
символ добивки — 0
сброс номера — ежегодно year
часовой пояс — Europe/Moscow
прямая нумерация — 0

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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/Moscow",
                  "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/Moscow",
                  "isDirectNumeration": 0
                }
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.add

try
        {
            const response = await $b24.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/Moscow',
                                isDirectNumeration: 0
                            }
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.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/Moscow',
                                '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/Moscow',
                            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/Moscow',
                            'isDirectNumeration' => 0,
                        ],
                    ],
                ],
            ]
        );
        
        print_r($result);

Обработка ответа

HTTP-статус: 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/Moscow",
                            "isDirectNumeration": false
                        }
                    }
                }
            },
            "time": {
                "start": 1774360939,
                "finish": 1774360939.968711,
                "duration": 0.9687108993530273,
                "processing": 0,
                "date_start": "2026-03-24T17:02:19+03:00",
                "date_finish": "2026-03-24T17:02:19+03:00",
                "operating_reset_at": 1774361539,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
numerator `object`	Созданный нумератор (подробное описание)

Объект numerator

Название `тип`	Описание
id `integer`	Идентификатор нумератора
name `string`	Название нумератора
template `string`	Шаблон номера
code `string`	Символьный код нумератора. Может быть `null`
settings `object`	Настройки генераторов нумератора (подробное описание)

Объект settings

Название `тип`	Описание
Bitrix_Main_Numerator_Generator_SequentNumberGenerator `object`	Настройки последовательной нумерации (подробное описание)

Объект Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Название `тип`	Описание
start `integer`	Начальное значение счетчика
step `integer`	Шаг увеличения счетчика
length `integer`	Минимальная длина номера
padString `string`	Символ добивки слева при `length > 0`
periodicBy `string`	Период сброса счетчика
timezone `string`	Идентификатор часового пояса для периодического сброса
isDirectNumeration `boolean`	Признак прямой нумерации

Обработка ошибок

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	`100`	Could not find value for parameter	Не передан обязательный параметр `fields`
`400`	`0`	Empty required fields: name, template	Не переданы обязательные поля `name` и `template` внутри `fields`
`400`	`0`	You do not have permissions to modify templates	Недостаточно прав на изменение шаблонов генератора документов

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Изменить нумератор

Добавить нумератор documentgenerator.numerator.add

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Параметр settingsПараметр settings

Параметры Bitrix_Main_Numerator_Generator_SequentNumberGeneratorПараметры Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект numeratorОбъект numerator

Объект settingsОбъект settings

Объект Bitrix_Main_Numerator_Generator_SequentNumberGeneratorОбъект Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение