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

Scope: crm

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

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

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

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

Название
тип

Описание

fields*
object

Объект с параметрами нумератора формата:

{
            "field_1": "value_1",
            "field_2": "value_2",
            "...": "..."
        }

где:

field_n — название поля
value_n — значение поля

Список полей — ниже

Параметр fields

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

Название `тип`	Описание
name* `string`	Название нумератора
template* `string`	Шаблон номера, например `{NUMBER}`
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`	Признак прямой нумерации. По умолчанию `false`

Примеры кода

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

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

название — Нумератор из REST
шаблон — {NUMBER}
стартовая нумерация — с 1, шаг 1

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","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","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

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.numerator.add',
        		{
        			fields: {
        				name: 'Нумератор из REST',
        				template: '{NUMBER}',
        				settings: {
        					Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
        						start: 1,
        						step: 1,
        						length: 6,
        						padString: '0',
        						periodicBy: '',
        						timezone: '',
        						isDirectNumeration: false,
        					},
        				},
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.numerator.add',
                    [
                        'fields' => [
                            'name' => 'Нумератор из REST',
                            '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',
                    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',
                    '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>';

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

HTTP-статус: 200

{
            "result": {
                "numerator": {
                    "name": "Нумератор из REST",
                    "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
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа. Содержит объект `numerator`
time `time`	Информация о времени выполнения запроса

Тип numerator

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

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

HTTP-статус: 400

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

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

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

Код	Описание	Значение
`100`	Invalid value {...} to match with parameter {fields}. Should be value of type array.	Параметр `fields` передан не как массив/объект
`0`	`Empty required fields: ...`	Не переданы обязательные поля
`Пустое значение`	`You do not have permissions to modify templates`	Недостаточно прав для изменения шаблонов генератора документов
`Пустое значение`	`Module documentgenerator is not installed`	Модуль `documentgenerator` недоступен

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

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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Изменить существующий нумератор

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

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

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

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

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

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

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

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

Тип numeratorТип numerator

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

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

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

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