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

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

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

Scope: crm

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

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

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

Без параметров

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.recurring.fields
        
// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmDealRecurringFields = Record<string, CrmDealRecurringFieldDescription>
        
        type CrmDealRecurringFieldDescription = {
          type: string
          isRequired: boolean
          isReadOnly: boolean
          isImmutable: boolean
          isMultiple: boolean
          isDynamic: boolean
          title: string
          definition?: Record<string, unknown>
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmDealRecurringFields>({
            method: 'crm.deal.recurring.fields',
            params: {},
            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 fields:', Object.keys(result))
          }
        } 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 getRecurringDealFields() {
            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.fields',
                params: {},
                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 fields:', Object.keys(result))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRecurringDealFields)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching recurring deal fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.recurring.fields',
            {},
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.fields',
            []
        );
        
        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.fields().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": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "id"
                },
                "DEAL_ID": {
                    "type": "integer",
                    "isRequired": true,
                    "isReadOnly": false,
                    "isImmutable": true,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "id регулярной сделки"
                },
                "BASED_ID": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Создано на основании"
                },
                "ACTIVE": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Активен"
                },
                "NEXT_EXECUTION": {
                    "type": "datetime",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Дата следующего выполнения"
                },
                "LAST_EXECUTION": {
                    "type": "datetime",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Дата последнего выполнения"
                },
                "COUNTER_REPEAT": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": true,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Количество выполнений"
                },
                "START_DATE": {
                    "type": "date",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Дата начала расчета"
                },
                "CATEGORY_ID": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Категория новой сделки"
                },
                "IS_LIMIT": {
                    "type": "char",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Тип ограничений выполнения"
                },
                "LIMIT_REPEAT": {
                    "type": "integer",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Ограничение по количеству выполнения"
                },
                "LIMIT_DATE": {
                    "type": "date",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "title": "Ограничение по дате"
                },
                "PARAMS": {
                    "type": "recurring_params",
                    "isRequired": false,
                    "isReadOnly": false,
                    "isImmutable": false,
                    "isMultiple": false,
                    "isDynamic": false,
                    "definition": {
                        "MODE": {
                            "type": "string",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Режим повторения"
                        },
                        "SINGLE_BEFORE_START_DATE_VALUE": {
                            "type": "integer",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Смещение до даты расчета"
                        },
                        "SINGLE_BEFORE_START_DATE_TYPE": {
                            "type": "string",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Тип смещения до даты расчета"
                        },
                        "MULTIPLE_TYPE": {
                            "type": "string",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Тип повторения"
                        },
                        "MULTIPLE_INTERVAL": {
                            "type": "integer",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Интервал повторения"
                        },
                        "OFFSET_BEGINDATE_TYPE": {
                            "type": "string",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Тип смещения для даты начала в новой сделке"
                        },
                        "OFFSET_BEGINDATE_VALUE": {
                            "type": "integer",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Смещение для даты начала в новой сделке"
                        },
                        "OFFSET_CLOSEDATE_TYPE": {
                            "type": "string",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Тип смещения для даты завершения в новой сделке"
                        },
                        "OFFSET_CLOSEDATE_VALUE": {
                            "type": "integer",
                            "isRequired": false,
                            "isReadOnly": false,
                            "isImmutable": false,
                            "isMultiple": false,
                            "isDynamic": false,
                            "title": "Смещение для даты завершения в новой сделке"
                        }
                    },
                    "title": "Параметры для расчета даты следующего выполнения"
                }
            },
            "time": {
                "start": 1772690452,
                "finish": 1772690452.454308,
                "duration": 0.45430803298950195,
                "processing": 0,
                "date_start": "2026-03-05T09:00:52+03:00",
                "date_finish": "2026-03-05T09:00:52+03:00",
                "operating_reset_at": 1772691052,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит описание полей шаблона

time
time

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

Обзор полей шаблона регулярной сделки

Поле тип

Описание

Примечание

ID
integer

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

Только для чтения

DEAL_ID
integer

id регулярной сделки

Неизменяемое

BASED_ID
integer

id сделки, на основании которой был создан шаблон

Только для чтения

ACTIVE
char

Флаг активности

Значения: Y / N

NEXT_EXECUTION
datetime

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

Только для чтения

LAST_EXECUTION
datetime

Дата и время последнего создания сделки из шаблона

Только для чтения

COUNTER_REPEAT
integer

Количество созданных из шаблона сделок

Только для чтения

START_DATE
date

Дата начала расчета следующего запуска

Если не указана, расчет идет от текущей даты

CATEGORY_ID
char

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

IS_LIMIT
char

Тип ограничения на создание сделок

N — без ограничений, D — по дате, T — по количеству

LIMIT_REPEAT
integer

Максимальное число создаваемых сделок

Используется при IS_LIMIT = T

LIMIT_DATE
date

Дата окончания генерации сделок

Используется при IS_LIMIT = D

PARAMS
recurring_params

Параметры для расчета даты следующего выполнения

Структура полей — ниже

Поля объекта 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

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

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Access denied

Недостаточно прав для доступа к CRM

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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

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