метод REST
scope: documentgenerator
documentgenerator.numerator.get
Получить нумератор по идентификатору
Описание
Метод documentgenerator.numerator.get возвращает данные нумератора по идентификатору.
Параметры
id
integer
обязательный
Идентификатор нумератора.
Получить идентификатор можно после создания нумератора или методом получения списка нумераторов
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":55}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.numerator.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":55,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.get
// 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 NumeratorGetResult = {
numerator: {
id: string
name: string
template: string
code: string | null
settings: Record<string, {
start: number
step: number
length: number
padString: string
periodicBy: string
timezone: string
isDirectNumeration: boolean
}>
}
}
try {
const response = await $b24.actions.v2.call.make<NumeratorGetResult>({
method: 'documentgenerator.numerator.get',
params: {
id: 55,
},
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(result.numerator.id, result.numerator.name, result.numerator.template)
}
} 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 getNumerator() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.numerator.get',
params: {
id: 55,
},
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(result.numerator.id, result.numerator.name, result.numerator.template)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getNumerator)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.documentgenerator.numerator.get(
bitrix_id=55,
).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}")
try {
$response = $b24Service->core->call(
'documentgenerator.numerator.get',
[
'id' => 55,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.numerator.get',
{
id: 55
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'documentgenerator.numerator.get',
[
'id' => 55,
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.numerator.get", b24.Params{
"id": 55,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("documentgenerator.numerator.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "numerator".
raw, ok := b24.Unwrap(res.Result, "numerator")
if !ok {
return fmt.Errorf("в ответе нет ключа numerator")
}
var item struct {
Name string `json:"name"`
Template string `json:"template"`
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Template)
Ответ
HTTP-статус: 200
{
"result": {
"numerator": {
"name": "REST Invoice Numerator Updated",
"template": "INV-UPD-{NUMBER}",
"id": "55",
"code": null,
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 2000,
"step": 10,
"length": 8,
"padString": "0",
"periodicBy": "year",
"timezone": "Europe/Moscow",
"isDirectNumeration": false
}
}
}
},
"time": {
"start": 1774363151,
"finish": 1774363151.551318,
"duration": 0.5513179302215576,
"processing": 0,
"date_start": "2026-03-24T17:39:11+03:00",
"date_finish": "2026-03-24T17:39:11+03:00",
"operating_reset_at": 1774363751,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "DOCGEN_ACCESS_ERROR",
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
400 |
100 |
Bitrix\Main\Numerator\Numerator constructor must be is public |
400 |
100 |
Could not construct parameter {numerator} |
400 |
0 |
You do not have permissions to modify templates |

