Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «чтения» сделок
Метод crm.deal.recurring.get возвращает поля настройки шаблона регулярной сделки по идентификатору.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор настройки шаблона регулярной сделки. Идентификатор можно получить с помощью методов crm.deal.recurring.list или crm.deal.recurring.add |
Примеры кода
Как использовать примеры в документации
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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmDealRecurring = {
ID: string
DEAL_ID: string
BASED_ID: string
ACTIVE: string
CATEGORY_ID: string
IS_LIMIT: string
COUNTER_REPEAT: string | null
LIMIT_REPEAT: string | null
LIMIT_DATE: ISODate | null
START_DATE: ISODate | null
NEXT_EXECUTION: ISODate | null
LAST_EXECUTION: ISODate | null
PARAMS: {
MODE: string
MULTIPLE_TYPE: string
MULTIPLE_INTERVAL: number
}
}
try {
const response = await $b24.actions.v2.call.make<CrmDealRecurring>({
method: 'crm.deal.recurring.get',
params: {
id: 15,
},
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('Recurring template:', result.ID, result.ACTIVE)
}
} 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 getRecurringDeal() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.recurring.get',
params: {
id: 15,
},
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('Recurring template:', result.ID, result.ACTIVE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRecurringDeal)
</script>
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>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.deal.recurring.get(bitrix_id=77).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}")
Обработка ответа
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 |
Корневой элемент ответа. Содержит поля настройки шаблона регулярной сделки |
|
time |
Информация о времени выполнения запроса |
Тип recurring_deal
|
Название |
Описание |
|
ID |
Идентификатор записи в таблице настроек регулярной сделки |
|
DEAL_ID |
Идентификатор сделки, для которой настроена регулярность |
|
BASED_ID |
Идентификатор сделки, на основании которой создан шаблон |
|
ACTIVE |
Флаг активности. Возможные значения:
|
|
NEXT_EXECUTION |
Дата и время следующего создания сделки из шаблона |
|
LAST_EXECUTION |
Дата и время последнего создания сделки из шаблона. Может быть пустой строкой, если запусков еще не было |
|
COUNTER_REPEAT |
Количество созданных из шаблона сделок. |
|
START_DATE |
Дата начала расчета следующего запуска. В ответе возвращается в формате |
|
CATEGORY_ID |
Идентификатор воронки для создаваемых сделок |
|
IS_LIMIT |
Тип ограничения на создание сделок:
|
|
LIMIT_REPEAT |
Максимальное количество создаваемых сделок. Используется при |
|
LIMIT_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 |
Значение смещения даты завершения создаваемой сделки |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Recurring deal is not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
В параметр |
|
|
Регулярные сделки недоступны в Битрикс24 |
|
|
Шаблон регулярной сделки не найден |
|
|
Недостаточно прав для чтения шаблона регулярной сделки |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список полей шаблона регулярной сделки crm.deal.recurring.fields
- Получить список настроек шаблонов регулярных сделок crm.deal.recurring.list
- Создать шаблон регулярной сделки crm.deal.recurring.add
- Изменить настройку шаблона регулярной сделки crm.deal.recurring.update
- Удалить настройку шаблона регулярной сделки crm.deal.recurring.delete
- Создать новую сделку из шаблона crm.deal.recurring.expose