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

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

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

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

Название
тип

Описание

id^*
integer

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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

// 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`	Информация о времени выполнения запроса

Тип 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 `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

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

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

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

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

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

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

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

Тип recurring_dealТип recurring_deal

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

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

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

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

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