Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get

Scope: crm

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

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

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

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

Название
тип

Описание

id^*
integer

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.recurring.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.recurring.get',
        		{
        			id: 15,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info('Настройка шаблона:', result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.get',
                    [
                        'id' => 15,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Recurring settings: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting recurring settings: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.recurring.get',
            {
                id: 15
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.get',
            [
                'id' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": "25",
                "DEAL_ID": "7591",
                "BASED_ID": "7577",
                "ACTIVE": "Y",
                "CATEGORY_ID": "2",
                "IS_LIMIT": "D",
                "COUNTER_REPEAT": null,
                "LIMIT_REPEAT": null,
                "LIMIT_DATE": "2027-03-05T03:00:00+03:00",
                "START_DATE": "2026-04-05T03:00:00+03:00",
                "NEXT_EXECUTION": "2026-04-05T01:00:00+03:00",
                "LAST_EXECUTION": "",
                "PARAMS": {
                    "MODE": "multiple",
                    "SINGLE_BEFORE_START_DATE_TYPE": null,
                    "SINGLE_BEFORE_START_DATE_VALUE": 0,
                    "MULTIPLE_TYPE": "month",
                    "MULTIPLE_INTERVAL": 1,
                    "OFFSET_BEGINDATE_TYPE": "day",
                    "OFFSET_BEGINDATE_VALUE": 1,
                    "OFFSET_CLOSEDATE_TYPE": "month",
                    "OFFSET_CLOSEDATE_VALUE": 2
                }
            },
            "time": {
                "start": 1772753726,
                "finish": 1772753726.940512,
                "duration": 0.94051194190979,
                "processing": 0,
                "date_start": "2026-03-06T02:35:26+03:00",
                "date_finish": "2026-03-06T02:35:26+03:00",
                "operating_reset_at": 1772754326,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `recurring_deal`	Корневой элемент ответа. Содержит поля настройки шаблона регулярной сделки
time `time`	Информация о времени выполнения запроса

Тип recurring_deal

Название `тип`	Описание
ID `integer`	Идентификатор записи в таблице настроек регулярной сделки
DEAL_ID `integer`	Идентификатор сделки, для которой настроена регулярность
BASED_ID `integer`	Идентификатор сделки, на основании которой создан шаблон
ACTIVE `char`	Флаг активности. Возможные значения: `Y` — активна `N` — неактивна
NEXT_EXECUTION `datetime`	Дата и время следующего создания сделки из шаблона
LAST_EXECUTION `datetime`	Дата и время последнего создания сделки из шаблона. Может быть пустой строкой, если запусков еще не было
COUNTER_REPEAT `integer`	Количество созданных из шаблона сделок.
START_DATE `datetime`	Дата начала расчета следующего запуска. В ответе возвращается в формате `YYYY-MM-DDTHH:MI:SS+TZD`
CATEGORY_ID `char`	Идентификатор воронки для создаваемых сделок
IS_LIMIT `char`	Тип ограничения на создание сделок: `N` — без ограничений `D` — по дате (`LIMIT_DATE`) `T` — по количеству (`LIMIT_REPEAT`)
LIMIT_REPEAT `integer`	Максимальное количество создаваемых сделок. Используется при `IS_LIMIT = T`
LIMIT_DATE `datetime`	Дата окончания генерации сделок. Используется при `IS_LIMIT = D`. В ответе возвращается в формате `YYYY-MM-DDTHH:MI:SS+TZD`
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`. Для `MODE = multiple` обычно возвращается `0`
OFFSET_BEGINDATE_TYPE `string`	Тип смещения даты начала создаваемой сделки: `day` `week` `month` `year`
OFFSET_BEGINDATE_VALUE `integer`	Значение смещения даты начала создаваемой сделки
OFFSET_CLOSEDATE_TYPE `string`	Тип смещения даты завершения создаваемой сделки: `day` `week` `month` `year`
OFFSET_CLOSEDATE_VALUE `integer`	Значение смещения даты завершения создаваемой сделки

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Recurring deal is not found."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`id is not defined or invalid`	В параметр `id` передано пустое или некорректное значение
`Recurring is not allowed`	Регулярные сделки недоступны в Битрикс24
`Recurring deal is not found`	Шаблон регулярной сделки не найден
`Access denied`	Недостаточно прав для чтения шаблона регулярной сделки

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

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

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

Изменить существующую настройку для шаблона регулярной сделки

Получить список настроек шаблонов регулярных сделок

Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get

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

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Тип recurring_dealТип recurring_deal

Поля объекта PARAMSПоля объекта PARAMS

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

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

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

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