# crm.documentgenerator.numerator.get

URL: https://chugunov.pro/api-bitrix24/crm/document-generator/numerator/crm-document-generator-numerator-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить информацию о нумераторе
Scope: `crm`
Кто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов

## Описание

Метод `crm.documentgenerator.numerator.get` возвращает информацию о нумераторе по его идентификатору.

## Параметры

- `id` `integer` — обязательный. Идентификатор нумератора

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "numerator": {
            "id": "45",
            "name": "Нумератор из REST (обновлен)",
            "template": "INV-{NUMBER}",
            "code": null,
            "settings": {
                "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                    "start": 100,
                    "step": 1,
                    "length": 0,
                    "padString": "0",
                    "periodicBy": null,
                    "timezone": null,
                    "isDirectNumeration": false
                }
            }
        }
    },
    "time": {
        "start": 1773747475,
        "finish": 1773747475.904903,
        "duration": 0.9049029350280762,
        "processing": 0,
        "date_start": "2026-03-17T14:37:55+03:00",
        "date_finish": "2026-03-17T14:37:55+03:00",
        "operating_reset_at": 1773748075,
        "operating": 0
    }
}
```

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

- `result` `object`. Корневой элемент ответа. Содержит объект [`numerator`](#numerator)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "100",
    "error_description": "Could not construct parameter {numerator}"
}
```

- `100` — `Bitrix\Main\Numerator\Numerator constructor must be is public`. Ошибка при создании объекта нумератора
- `100` — `Could not construct parameter {numerator}`. Нумератор с указанным `id` не найден
- `DOCGEN_ACCESS_ERROR` — `Access denied`. Нет доступа к нумератору, либо нумератор не относится к модулю генератора документов
- — — `You do not have permissions to modify templates`. Недостаточно прав для изменения шаблонов генератора документов
- — — `Module documentgenerator is not installed`. Модуль `documentgenerator` недоступен

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.numerator.get
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.numerator.get
```

### JS (TS)

```ts
// 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 | null
      timezone: string | null
      isDirectNumeration: boolean
    }>
  }
}

try {
  const response = await $b24.actions.v2.call.make<NumeratorGetResult>({
    method: 'crm.documentgenerator.numerator.get',
    params: {
      id: 45,
    },
    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)
}
```

### JS (UMD)

```html
<!-- 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: 'crm.documentgenerator.numerator.get',
        params: {
          id: 45,
        },
        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>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.documentgenerator.numerator.get(bitrix_id=45).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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.documentgenerator.numerator.get',
            [
                'id' => 45,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting numerator: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'crm.documentgenerator.numerator.get',
    {
        id: 45,
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'crm.documentgenerator.numerator.get',
    [
        'id' => 45,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.numerator.get", b24.Params{
	"id": 45,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.documentgenerator.numerator.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "numerator".
raw, ok := b24.Unwrap(res.Result, "numerator")
if !ok {
	return fmt.Errorf("в ответе нет ключа numerator")
}

var item struct {
	ID       b24.ID `json:"id"`
	Name     string `json:"name"`
	Template string `json:"template"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get.html