метод REST scope: documentgenerator

documentgenerator.numerator.list

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

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

Описание

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

Параметры

start integer необязательный

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

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

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

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

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

Примеры запроса

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

Ответ

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

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to modify templates"
}
Код Описание Значение
400 0 You do not have permissions to modify templates

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.