crm.deal.recurring.get
Получить настройки шаблона регулярной сделки по id
Описание
Метод crm.deal.recurring.get возвращает поля настройки шаблона регулярной сделки по идентификатору.
Параметры
id
integer
необязательный
Идентификатор настройки шаблона регулярной сделки.
Идентификатор можно получить с помощью методов 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.recurring.get", b24.Params{
"id": 15,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.recurring.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
DealID b24.ID `json:"DEAL_ID"`
BasedID b24.ID `json:"BASED_ID"`
Active string `json:"ACTIVE"`
CategoryID b24.ID `json:"CATEGORY_ID"`
IsLimit string `json:"IS_LIMIT"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.DealID)
Ответ
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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Recurring deal is not found."
}
| Код | Описание | Значение |
|---|---|---|
id is not defined or invalid |
В параметр id передано пустое или некорректное значение |
|
Recurring is not allowed |
Регулярные сделки недоступны в Битрикс24 | |
Recurring deal is not found |
Шаблон регулярной сделки не найден | |
Access denied |
Недостаточно прав для чтения шаблона регулярной сделки |

