Изменить нумератор crm.documentgenerator.numerator.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом "изменения" шаблонов генератора документов
Метод crm.documentgenerator.numerator.update обновляет существующий нумератор.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор нумератора |
|
fields* |
Объект с полями для обновления в формате:
где:
Список полей — ниже |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name |
Название нумератора |
|
template |
Шаблон номера, например |
|
settings |
Настройки генераторов. Описание параметров — ниже |
Параметр settings
|
Название |
Описание |
|
Bitrix_Main_Numerator_Generator_SequentNumberGenerator |
Настройки последовательной нумерации. Описание параметров — ниже |
Параметры Bitrix_Main_Numerator_Generator_SequentNumberGenerator
|
Название |
Описание |
|
start |
Начальное значение счетчика. По умолчанию |
|
step |
Шаг увеличения счетчика. По умолчанию |
|
length |
Минимальная длина номера. По умолчанию |
|
padString |
Символ добивки слева при |
|
periodicBy |
Период сброса счетчика:
|
|
timezone |
Идентификатор часового пояса для периодического сброса, например |
|
isDirectNumeration |
Признак прямой нумерации. По умолчанию |
Примеры кода
Как использовать примеры в документации
Пример обновления нумератора:
- новый шаблон —
INV-{NUMBER} - старт последовательности —
100 - шаг —
1
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45,"fields":{"name":"Нумератор из REST (обновлен)","template":"INV-{NUMBER}","settings":{"Bitrix_Main_Numerator_Generator_SequentNumberGenerator":{"start":100,"step":1,"length":6,"padString":"0","periodicBy":"","timezone":"","isDirectNumeration":false}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.numerator.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":45,"fields":{"name":"Нумератор из REST (обновлен)","template":"INV-{NUMBER}","settings":{"Bitrix_Main_Numerator_Generator_SequentNumberGenerator":{"start":100,"step":1,"length":6,"padString":"0","periodicBy":"","timezone":"","isDirectNumeration":false}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.documentgenerator.numerator.update
// 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 NumeratorUpdateResult = {
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
}
}
}
try {
const response = await $b24.actions.v2.call.make<NumeratorUpdateResult>({
method: 'crm.documentgenerator.numerator.update',
params: {
id: 45,
fields: {
name: 'Numerator from REST (updated)',
template: 'INV-{NUMBER}',
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: 100,
step: 1,
length: 6,
padString: '0',
periodicBy: '',
timezone: '',
isDirectNumeration: false,
},
},
},
},
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.id, result.name, result.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 updateNumerator() {
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.update',
params: {
id: 45,
fields: {
name: 'Numerator from REST (updated)',
template: 'INV-{NUMBER}',
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: 100,
step: 1,
length: 6,
padString: '0',
periodicBy: '',
timezone: '',
isDirectNumeration: false,
},
},
},
},
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.id, result.name, result.template)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateNumerator)
</script>
try {
$response = $b24Service
->core
->call(
'crm.documentgenerator.numerator.update',
[
'id' => 45,
'fields' => [
'name' => 'Нумератор из REST (обновлен)',
'template' => 'INV-{NUMBER}',
'settings' => [
'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
'start' => 100,
'step' => 1,
'length' => 6,
'padString' => '0',
'periodicBy' => '',
'timezone' => '',
'isDirectNumeration' => false,
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating numerator: ' . $e->getMessage();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.numerator.update(
bitrix_id=45,
fields={
"name": "Нумератор из REST (обновлен)",
"template": "INV-{NUMBER}",
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 100,
"step": 1,
"length": 6,
"padString": "0",
"periodicBy": "",
"timezone": "",
"isDirectNumeration": False,
},
},
},
).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}")
BX24.callMethod(
'crm.documentgenerator.numerator.update',
{
id: 45,
fields: {
name: 'Нумератор из REST (обновлен)',
template: 'INV-{NUMBER}',
settings: {
Bitrix_Main_Numerator_Generator_SequentNumberGenerator: {
start: 100,
step: 1,
length: 6,
padString: '0',
periodicBy: '',
timezone: '',
isDirectNumeration: false,
},
},
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.documentgenerator.numerator.update',
[
'id' => 45,
'fields' => [
'name' => 'Нумератор из REST (обновлен)',
'template' => 'INV-{NUMBER}',
'settings' => [
'Bitrix_Main_Numerator_Generator_SequentNumberGenerator' => [
'start' => 100,
'step' => 1,
'length' => 6,
'padString' => '0',
'periodicBy' => '',
'timezone' => '',
'isDirectNumeration' => false,
],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"name": "Нумератор из REST (обновлен)",
"template": "INV-{NUMBER}",
"id": "45",
"code": null,
"settings": {
"Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
"start": 100,
"step": 1,
"length": 0,
"padString": "0",
"periodicBy": null,
"timezone": null,
"isDirectNumeration": false
}
}
},
"time": {
"start": 1773743992,
"finish": 1773743992.664487,
"duration": 0.6644868850708008,
"processing": 0,
"date_start": "2026-03-17T13:39:52+03:00",
"date_finish": "2026-03-17T13:39:52+03:00",
"operating_reset_at": 1773744592,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит данные нумератора напрямую в формате |
|
time |
Информация о времени выполнения запроса |
Тип result
|
Название |
Описание |
|
id |
Идентификатор нумератора |
|
name |
Название нумератора |
|
template |
Шаблон номера |
|
code |
Символьный код нумератора. Может быть |
|
settings |
Сохраненные настройки последовательной нумерации типа |
Тип settings
|
Название |
Описание |
|
start |
Начальное значение счетчика |
|
step |
Шаг увеличения счетчика |
|
length |
Минимальная длина номера |
|
padString |
Символ добивки слева |
|
periodicBy |
Период сброса счетчика: |
|
timezone |
Идентификатор часового пояса для периодического сброса. Может быть |
|
isDirectNumeration |
Признак прямой нумерации |
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Could not construct parameter {numerator}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Не передан обязательный параметр |
|
|
|
Внутренняя ошибка при создании объекта нумератора |
|
|
Invalid value {...} to match with parameter {fields}. Should be value of type array. |
Параметр |
|
|
|
Нумератор с указанным |
|
|
|
Нет доступа к нумератору. Метод обновляет только нумераторы, созданные через REST |
|
|
|
Недостаточно прав для изменения шаблонов генератора документов |
|
|
|
Модуль |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить новый нумератор crm.documentgenerator.numerator.add
- Получить информацию о нумераторе crm.documentgenerator.numerator.get
- Получить список нумераторов crm.documentgenerator.numerator.list
- Удалить нумератор crm.documentgenerator.numerator.delete
- Как добавить шаблон и создать документ на его основе