Получить список нумераторов documentgenerator.numerator.list

Scope: documentgenerator

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

Метод documentgenerator.numerator.list возвращает список нумераторов для генератора документов. Возвращает все нумераторы, доступные в текущем Битрикс24, в том числе CRM нумераторы.

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

Название
тип

Описание

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 элементов.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов, необходимо передавать 100 и так далее.

Формула расчета значения start:

start = (N - 1) * 50, где N — номер нужной страницы

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"start":0}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.numerator.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"start":0,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.list

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.numerator.list',
                {
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.numerator.list',
                [
                    'start' => 0,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.numerator.list',
            {
                start: 0
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.numerator.list',
            [
                'start' => 0,
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "numerators": [
                    ..., // описание других нумераторов, в том числе CRM
                    {
                        "id": "53",
                        "name": "Общий номер",
                        "template": "{NUMBER}",
                        "settings": {
                            "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                                "start": 1,
                                "step": 1,
                                "length": 0,
                                "padString": "0",
                                "periodicBy": null,
                                "timezone": null,
                                "isDirectNumeration": false
                            }
                        }
                    },
                    {
                        "id": "55",
                        "name": "REST Invoice Numerator Updated",
                        "template": "INV-UPD-{NUMBER}",
                        "settings": {
                            "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                                "start": 2000,
                                "step": 10,
                                "length": 8,
                                "padString": "0",
                                "periodicBy": "year",
                                "timezone": "Europe/Moscow",
                                "isDirectNumeration": false
                            }
                        }
                    }
                ]
            },
            "total": 20,
            "time": {
                "start": 1774363478,
                "finish": 1774363478.809978,
                "duration": 0.8099780082702637,
                "processing": 0,
                "date_start": "2026-03-24T17:44:38+03:00",
                "date_finish": "2026-03-24T17:44:38+03:00",
                "operating_reset_at": 1774364078,
                "operating": 0
            }
        }

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

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

Объект result

Название `тип`	Описание
numerators `array`	Список нумераторов (подробное описание)

Элемент массива numerators

Название `тип`	Описание
id `string`	Идентификатор нумератора
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`	Период сброса счетчика. Может быть `null`
timezone `string`	Идентификатор часового пояса для периодического сброса. Может быть `null`
isDirectNumeration `boolean`	Признак прямой нумерации

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "You do not have permissions to modify templates"
        }

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

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

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

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

Получить нумератор по id

Удалить нумератор

Получить список нумераторов documentgenerator.numerator.list

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

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

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

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

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

Элемент массива numeratorsЭлемент массива numerators

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

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

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

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

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

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