Создать шаблон регулярной сделки crm.deal.recurring.add
Scope:
crmКто может выполнять метод: пользователь с правами «добавление» и «изменение» сделок
Метод crm.deal.recurring.add создает шаблон регулярной сделки на основе сделки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект формата:
где:
Список доступных полей описан ниже |
Параметр fields
|
Название |
Описание |
|
DEAL_ID |
Идентификатор сделки, на основе которой создается шаблон регулярной сделки. Идентификатор сделки можно получить с помощью методов crm.deal.list или crm.deal.add |
|
ACTIVE |
Флаг активности настройки. Возможные значения:
|
|
CATEGORY_ID |
id воронки для новых сделок, создаваемых из шаблона. Список доступных воронок можно узнать с помощью метода crm.category.list, передав |
|
IS_LIMIT |
Ограничение по созданию новых сделок: Если передано любое другое значение, оно будет приведено к |
|
LIMIT_REPEAT |
Максимальное количество сделок, которые можно создать из шаблона. Используется при |
|
LIMIT_DATE |
Дата окончания генерации сделок из шаблона в формате |
|
START_DATE |
Дата начала расчета следующего запуска в формате |
|
PARAMS |
Параметры периодичности (подробное описание) |
Параметр PARAMS
|
Название |
Описание |
|
MODE |
Режим повторения: |
|
MULTIPLE_TYPE |
Тип периода для |
|
MULTIPLE_INTERVAL |
Интервал повторения для |
|
SINGLE_BEFORE_START_DATE_TYPE |
Тип смещения для |
|
SINGLE_BEFORE_START_DATE_VALUE |
Значение смещения для |
|
OFFSET_BEGINDATE_TYPE |
Тип смещения даты начала создаваемой сделки: |
|
OFFSET_BEGINDATE_VALUE |
Значение смещения даты начала создаваемой сделки |
|
OFFSET_CLOSEDATE_TYPE |
Тип смещения даты завершения создаваемой сделки: |
|
OFFSET_CLOSEDATE_VALUE |
Значение смещения даты завершения создаваемой сделки |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"DEAL_ID":45,"CATEGORY_ID":"1","IS_LIMIT":"D","LIMIT_DATE":"2027-03-04","START_DATE":"2026-04-04","PARAMS":{"MODE":"multiple","MULTIPLE_TYPE":"month","MULTIPLE_INTERVAL":1,"OFFSET_BEGINDATE_TYPE":"day","OFFSET_BEGINDATE_VALUE":1,"OFFSET_CLOSEDATE_TYPE":"month","OFFSET_CLOSEDATE_VALUE":2}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.recurring.add
try
{
const current = new Date();
const nextMonth = new Date();
const nextYear = new Date();
nextMonth.setMonth(current.getMonth() + 1);
nextYear.setFullYear(current.getFullYear() + 1);
const paddatepart = (part) => (part >= 10 ? part.toString() : `0${part}`);
const date2str = (d) =>
`${d.getFullYear()}-${paddatepart(1 + d.getMonth())}-${paddatepart(d.getDate())}`;
const response = await $b24.callMethod(
'crm.deal.recurring.add',
{
fields: {
DEAL_ID: 45,
CATEGORY_ID: '1',
IS_LIMIT: 'D',
LIMIT_DATE: date2str(nextYear),
START_DATE: date2str(nextMonth),
PARAMS: {
MODE: 'multiple',
MULTIPLE_TYPE: 'month',
MULTIPLE_INTERVAL: 1,
OFFSET_BEGINDATE_TYPE: 'day',
OFFSET_BEGINDATE_VALUE: 1,
OFFSET_CLOSEDATE_TYPE: 'month',
OFFSET_CLOSEDATE_VALUE: 2,
}
}
}
);
const result = response.getData().result;
console.info('id настройки регулярной сделки:', result);
}
catch(error)
{
console.error('Error:', error);
}
try {
$current = new DateTime();
$nextMonth = (clone $current)->modify('+1 month');
$nextYear = (clone $current)->modify('+1 year');
$response = $b24Service
->core
->call(
'crm.deal.recurring.add',
[
'fields' => [
'DEAL_ID' => 45,
'CATEGORY_ID' => '1',
'IS_LIMIT' => 'D',
'LIMIT_DATE' => $nextYear->format('Y-m-d'),
'START_DATE' => $nextMonth->format('Y-m-d'),
'PARAMS' => [
'MODE' => 'multiple',
'MULTIPLE_TYPE' => 'month',
'MULTIPLE_INTERVAL' => 1,
'OFFSET_BEGINDATE_TYPE' => 'day',
'OFFSET_BEGINDATE_VALUE' => 1,
'OFFSET_CLOSEDATE_TYPE' => 'month',
'OFFSET_CLOSEDATE_VALUE' => 2,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: id настройки регулярной сделки - ' . $result->data();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding recurring deal settings: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.recurring.add',
{
fields: {
DEAL_ID: 45,
CATEGORY_ID: '1',
IS_LIMIT: 'D',
LIMIT_DATE: '2027-03-04',
START_DATE: '2026-04-04',
PARAMS: {
MODE: 'multiple',
MULTIPLE_TYPE: 'month',
MULTIPLE_INTERVAL: 1,
OFFSET_BEGINDATE_TYPE: 'day',
OFFSET_BEGINDATE_VALUE: 1,
OFFSET_CLOSEDATE_TYPE: 'month',
OFFSET_CLOSEDATE_VALUE: 2
}
}
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.info('id настройки регулярной сделки:', result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.recurring.add',
[
'fields' => [
'DEAL_ID' => 45,
'CATEGORY_ID' => '1',
'IS_LIMIT' => 'D',
'LIMIT_DATE' => '2027-03-04',
'START_DATE' => '2026-04-04',
'PARAMS' => [
'MODE' => 'multiple',
'MULTIPLE_TYPE' => 'month',
'MULTIPLE_INTERVAL' => 1,
'OFFSET_BEGINDATE_TYPE' => 'day',
'OFFSET_BEGINDATE_VALUE' => 1,
'OFFSET_CLOSEDATE_TYPE' => 'month',
'OFFSET_CLOSEDATE_VALUE' => 2
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 15,
"time": {
"start": 1772664456,
"finish": 1772664457.379632,
"duration": 1.3796319961547852,
"processing": 1,
"date_start": "2026-03-05T01:47:36+03:00",
"date_finish": "2026-03-05T01:47:37+03:00",
"operating_reset_at": 1772665056,
"operating": 0.7352650165557861
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданной настройки шаблона регулярной сделки |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Deal already have had recurring settings."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Параметр |
|
|
Параметр |
|
|
В |
|
|
Недостаточно прав для изменения исходной сделки или создания сделок |
|
|
Для переданной сделки уже существует настройка регулярности |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список полей шаблона регулярной сделки crm.deal.recurring.fields
- Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get
- Получить список настроек шаблонов регулярных сделок crm.deal.recurring.list
- Изменить настройку шаблона регулярной сделки crm.deal.recurring.update
- Удалить настройку шаблона регулярной сделки crm.deal.recurring.delete
- Создать новую сделку из шаблона crm.deal.recurring.expose