Добавить нумератор documentgenerator.numerator.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: documentgenerator

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

Метод documentgenerator.numerator.add создает нумератор документов.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Набор параметров нумератора (подробное описание)

Параметр fields

Название
тип

Описание

name*
string

Название нумератора

template*
string

Шаблон номера с плейсхолдером {NUMBER}.

Плейсхолдер {NUMBER} нужно указывать в фигурных скобках. При генерации документа плейсхолдер заменяется на следующее значение счетчика по настройкам settings.

Примеры шаблонов:

  • {NUMBER}1000
  • INV-{NUMBER}INV-1000
  • DG/{NUMBER}/2026DG/1000/2026

settings
object

Настройки генераторов нумератора (подробное описание)

Параметр settings

Название
тип

Описание

Bitrix_Main_Numerator_Generator_SequentNumberGenerator
object

Настройки последовательной нумерации (подробное описание)

Параметры Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Название
тип

Описание

start
integer

Начальное значение счетчика.

По умолчанию 1

step
integer

Шаг увеличения счетчика.

По умолчанию 1

length
integer

Минимальная длина номера.

По умолчанию 0

padString
string

Символ добивки слева при length > 0.

По умолчанию 0

periodicBy
string

Период сброса счетчика:

  • '' — без сброса
  • day — ежедневно
  • month — ежемесячно
  • year — ежегодно

timezone
string

Идентификатор часового пояса для периодического сброса, например Europe/Moscow

isDirectNumeration
boolean

Признак прямой нумерации.

Возможные значения:

  • 0 — выключена
  • 1 — включена

По умолчанию 0.

В ответе метода значение возвращается в виде true | false

Примеры кода

Как использовать примеры в документации

Пример создания нумератора:

  • название — REST Invoice Numerator
  • шаблон — INV-{NUMBER}
  • стартовое значение — 1000
  • шаг — 5
  • минимальная длина номера — 8
  • символ добивки — 0
  • сброс номера — ежегодно year
  • часовой пояс — Europe/Moscow
  • прямая нумерация — 0
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "fields": {
      "name": "REST Invoice Numerator",
      "template": "INV-{NUMBER}",
      "settings": {
        "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
          "start": 1000,
          "step": 5,
          "length": 8,
          "padString": "0",
          "periodicBy": "year",
          "timezone": "Europe/Moscow",
          "isDirectNumeration": 0
        }
      }
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.numerator.add
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "fields": {
      "name": "REST Invoice Numerator",
      "template": "INV-{NUMBER}",
      "settings": {
        "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
          "start": 1000,
          "step": 5,
          "length": 8,
          "padString": "0",
          "periodicBy": "year",
          "timezone": "Europe/Moscow",
          "isDirectNumeration": 0
        }
      }
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.numerator.add
// 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 NumeratorAddResult = {
  numerator: {
    id: number
    name: string
    template: string
    code: string | null
    settings: {
      Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
        start: number
        step: number
        length: number
        padString: string
        periodicBy: string
        timezone: string
        isDirectNumeration: boolean
      }
    }
  }
}

try {
  const response = await $b24.actions.v2.call.make<NumeratorAddResult>({
    method: 'documentgenerator.numerator.add',
    params: {
      fields: {
        name: 'REST Invoice Numerator',
        template: 'INV-{NUMBER}',
        settings: {
          Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
            start: 1000,
            step: 5,
            length: 8,
            padString: '0',
            periodicBy: 'year',
            timezone: 'Europe/Moscow',
            isDirectNumeration: 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(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 addNumerator() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'documentgenerator.numerator.add',
        params: {
          fields: {
            name: 'REST Invoice Numerator',
            template: 'INV-{NUMBER}',
            settings: {
              Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                start: 1000,
                step: 5,
                length: 8,
                padString: '0',
                periodicBy: 'year',
                timezone: 'Europe/Moscow',
                isDirectNumeration: 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(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', addNumerator)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.documentgenerator.numerator.add(
        fields={
            "name": "REST Invoice Numerator",
            "template": "INV-{NUMBER}",
            "settings": {
                "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                    "start": 1000,
                    "step": 5,
                    "length": 8,
                    "padString": "0",
                    "periodicBy": "",
                    "timezone": "Europe/Moscow",
                },
            },
        },
    ).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.add',
        [
            'fields' => [
                'name' => 'REST Invoice Numerator',
                'template' => 'INV-{NUMBER}',
                'settings' => [
                    'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                        'start' => 1000,
                        'step' => 5,
                        'length' => 8,
                        'padString' => '0',
                        'periodicBy' => 'year',
                        'timezone' => 'Europe/Moscow',
                        'isDirectNumeration' => 0,
                    ],
                ],
            ],
        ]
    );

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'documentgenerator.numerator.add',
    {
        fields: {
            name: 'REST Invoice Numerator',
            template: 'INV-{NUMBER}',
            settings: {
                Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
                    start: 1000,
                    step: 5,
                    length: 8,
                    padString: '0',
                    periodicBy: 'year',
                    timezone: 'Europe/Moscow',
                    isDirectNumeration: 0
                }
            }
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.numerator.add',
    [
        'fields' => [
            'name' => 'REST Invoice Numerator',
            'template' => 'INV-{NUMBER}',
            'settings' => [
                'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
                    'start' => 1000,
                    'step' => 5,
                    'length' => 8,
                    'padString' => '0',
                    'periodicBy' => 'year',
                    'timezone' => 'Europe/Moscow',
                    'isDirectNumeration' => 0,
                ],
            ],
        ],
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.numerator.add", b24.Params{
	"fields": b24.Params{
		"name":     "REST Invoice Numerator",
		"template": "INV-{NUMBER}",
		"settings": b24.Params{
			"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": b24.Params{
				"start":              1000,
				"step":               5,
				"length":             8,
				"padString":          "0",
				"periodicBy":         "year",
				"timezone":           "Europe/Moscow",
				"isDirectNumeration": 0,
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("documentgenerator.numerator.add: %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",
            "template": "INV-{NUMBER}",
            "id": 55,
            "code": null,
            "settings": {
                "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                    "start": 1000,
                    "step": 5,
                    "length": 8,
                    "padString": "0",
                    "periodicBy": "year",
                    "timezone": "Europe/Moscow",
                    "isDirectNumeration": false
                }
            }
        }
    },
    "time": {
        "start": 1774360939,
        "finish": 1774360939.968711,
        "duration": 0.9687108993530273,
        "processing": 0,
        "date_start": "2026-03-24T17:02:19+03:00",
        "date_finish": "2026-03-24T17:02:19+03:00",
        "operating_reset_at": 1774361539,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

numerator
object

Созданный нумератор (подробное описание)

Объект numerator

Название
тип

Описание

id
integer

Идентификатор нумератора

name
string

Название нумератора

template
string

Шаблон номера

code
string

Символьный код нумератора. Может быть null

settings
object

Настройки генераторов нумератора (подробное описание)

Объект settings

Название
тип

Описание

Bitrix_Main_Numerator_Generator_SequentNumberGenerator
object

Настройки последовательной нумерации (подробное описание)

Объект Bitrix_Main_Numerator_Generator_SequentNumberGenerator

Название
тип

Описание

start
integer

Начальное значение счетчика

step
integer

Шаг увеличения счетчика

length
integer

Минимальная длина номера

padString
string

Символ добивки слева при length > 0

periodicBy
string

Период сброса счетчика

timezone
string

Идентификатор часового пояса для периодического сброса

isDirectNumeration
boolean

Признак прямой нумерации

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Empty required fields: name, template"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр fields

400

0

Empty required fields: name, template

Не переданы обязательные поля name и template внутри fields

400

0

You do not have permissions to modify templates

Недостаточно прав на изменение шаблонов генератора документов

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение