Получить список нумераторов documentgenerator.numerator.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
documentgeneratorКто может выполнять метод: пользователь с правом на изменение шаблонов генератора документов
Метод documentgenerator.numerator.list возвращает список нумераторов для генератора документов. Возвращает все нумераторы, доступные в текущем Битрикс24, в том числе CRM нумераторы.
Параметры метода
|
Название |
Описание |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 элементов. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения
|
Примеры кода
Как использовать примеры в документации
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
// 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
type NumeratorItem = {
id: string
name: string
template: string
code: string | null
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator?: {
start: number
step: number
length: number
padString: string
periodicBy: string | null
timezone: string | null
isDirectNumeration: boolean
}
}
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type NumeratorListResult = {
numerators: NumeratorItem[]
}
try {
// documentgenerator.numerator.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<NumeratorListResult>({
method: 'documentgenerator.numerator.list',
params: {
start: 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('Numerators:', result.numerators, 'Count:', result.numerators.length)
}
} 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 fetchNumeratorList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// documentgenerator.numerator.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.numerator.list',
params: {
start: 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('Numerators:', result.numerators, 'Count:', result.numerators.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchNumeratorList)
</script>
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',
{},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
if (result.more())
{
result.next();
}
}
}
);
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 |
Корневой элемент ответа (подробное описание) |
|
total |
Количество нумераторов в текущей выборке |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
numerators |
Список нумераторов (подробное описание) |
Элемент массива numerators
|
Название |
Описание |
|
id |
Идентификатор нумератора |
|
name |
Название нумератора |
|
template |
Шаблон номера |
|
code |
Символьный код нумератора. Может быть |
|
settings |
Настройки генераторов нумератора (подробное описание) |
Объект settings
|
Название |
Описание |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
Настройки последовательной нумерации (подробное описание) |
Объект Bitrix_Main_Numerator_Generator_SequentNumberGenerator
|
Название |
Описание |
|
start |
Начальное значение счетчика |
|
step |
Шаг увеличения счетчика |
|
length |
Минимальная длина номера |
|
padString |
Символ добивки слева при |
|
periodicBy |
Период сброса счетчика. Может быть |
|
timezone |
Идентификатор часового пояса для периодического сброса. Может быть |
|
isDirectNumeration |
Признак прямой нумерации |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "You do not have permissions to modify templates"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
You do not have permissions to modify templates |
Недостаточно прав на изменение шаблонов генератора документов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |