Создать шаблон регулярной сделки crm.deal.recurring.add

Scope: crm

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

Метод crm.deal.recurring.add создает шаблон регулярной сделки на основе сделки.

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

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

Название
тип

Описание

fields*
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

где:

  • field_n — название поля настройки
  • value_n — значение поля настройки

Список доступных полей описан ниже

Параметр fields

Название
тип

Описание

DEAL_ID
integer

Идентификатор сделки, на основе которой создается шаблон регулярной сделки.

Идентификатор сделки можно получить с помощью методов crm.deal.list или crm.deal.add

ACTIVE
char

Флаг активности настройки. Возможные значения:

  • Y — активна
  • N — неактивна

CATEGORY_ID
char

id воронки для новых сделок, создаваемых из шаблона.

Список доступных воронок можно узнать с помощью метода crm.category.list, передав entityTypeId = 2

IS_LIMIT
char

Ограничение по созданию новых сделок:
N — без ограничений
D — ограничение по дате (LIMIT_DATE)
T — ограничение по количеству (LIMIT_REPEAT)

Если передано любое другое значение, оно будет приведено к N

LIMIT_REPEAT
integer

Максимальное количество сделок, которые можно создать из шаблона. Используется при IS_LIMIT = T

LIMIT_DATE
date

Дата окончания генерации сделок из шаблона в формате YYYY-MM-DD. Используется при IS_LIMIT = D

START_DATE
date

Дата начала расчета следующего запуска в формате YYYY-MM-DD

PARAMS
object

Параметры периодичности (подробное описание)

Параметр PARAMS

Название
тип

Описание

MODE
string

Режим повторения:
single — одиночный
multiple — множественный

MULTIPLE_TYPE
string

Тип периода для MODE = multiple:
day, week, month, year

MULTIPLE_INTERVAL
integer

Интервал повторения для MODE = multiple

SINGLE_BEFORE_START_DATE_TYPE
string

Тип смещения для MODE = single:
day, week, month, year

SINGLE_BEFORE_START_DATE_VALUE
integer

Значение смещения для MODE = single

OFFSET_BEGINDATE_TYPE
string

Тип смещения даты начала создаваемой сделки:
day, week, month, year

OFFSET_BEGINDATE_VALUE
integer

Значение смещения даты начала создаваемой сделки

OFFSET_CLOSEDATE_TYPE
string

Тип смещения даты завершения создаваемой сделки:
day, week, month, year

OFFSET_CLOSEDATE_VALUE
integer

Значение смещения даты завершения создаваемой сделки

Примеры кода

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

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
integer

Идентификатор созданной настройки шаблона регулярной сделки

time
time

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Deal already have had recurring settings."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Parameter 'fields' must be array

Параметр fields не передан или передан не в формате объекта

Parameter 'params' must be array

Параметр params передан не в формате объекта

Deal id is empty

В fields.DEAL_ID передано пустое или некорректное значение

Access denied

Недостаточно прав для изменения исходной сделки или создания сделок

Deal already have had recurring settings

Для переданной сделки уже существует настройка регулярности

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

HTTP-статус: 20x, 40x, 50x

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

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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