метод REST
scope: crm
crm.documentgenerator.numerator.list
Получить список нумераторов
Описание
Метод crm.documentgenerator.numerator.list возвращает список нумераторов.
Параметры
start
integer
необязательный
Смещение для постраничной навигации. Подробнее в статье Особенности списочных методов
Примеры запроса
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**/crm.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/crm.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type NumeratorResult = {
numerators: {
id: string
name: string
template: string
settings: Record<string, {
start: number
step: number
length?: number
padString?: string
periodicBy: string | null
timezone: string | null
isDirectNumeration: boolean
}>
}[]
}
try {
// crm.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<NumeratorResult>({
method: 'crm.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 count:', result.numerators.length, result.numerators)
}
} 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 listNumerators() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.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: 'crm.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 count:', result.numerators.length, result.numerators)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listNumerators)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.numerator.list(start=0).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.numerator.list().as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.numerator.list().as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.numerator.list',
[
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting numerators list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.documentgenerator.numerator.list',
{},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
console.info(result.data());
if (result.more()) {
result.next();
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.numerator.list',
[
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.numerator.list", b24.Params{
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.documentgenerator.numerator.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "numerators".
raw, ok := b24.Unwrap(res.Result, "numerators")
if !ok {
return fmt.Errorf("в ответе нет ключа numerators")
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Template string `json:"template"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ
HTTP-статус: 200
{
"result": {
"numerators": [
{
"id": "2",
"name": "Акт (Россия)",
"template": "{NUMBER}",
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 1,
"step": 1,
"periodicBy": null,
"timezone": null,
"isDirectNumeration": false
}
}
},
{
"id": "45",
"name": "Нумератор из REST (обновлен)",
"template": "INV-{NUMBER}",
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 100,
"step": 1,
"length": 0,
"padString": "0",
"periodicBy": null,
"timezone": null,
"isDirectNumeration": false
}
}
}
]
},
"total": 19,
"time": {
"start": 1773750210,
"finish": 1773750210.283658,
"duration": 0.2836580276489258,
"processing": 0,
"date_start": "2026-03-17T15:23:30+03:00",
"date_finish": "2026-03-17T15:23:30+03:00",
"operating_reset_at": 1773750810,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа. Содержит массив объектов numerators
total
integer
Общее количество нумераторов
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "You do not have permissions to modify templates"
}
| Код | Описание | Значение |
|---|---|---|
| — | You do not have permissions to modify templates |
Недостаточно прав для изменения шаблонов генератора документов |
| — | Module documentgenerator is not installed |
Модуль documentgenerator недоступен |

