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

Scope: crm

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

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

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

Название `тип`	Описание
order `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` где: `field_n` — название поля для сортировки `value_n` — направление сортировки: `ASC` или `DESC` Список полей для сортировки можно получить методом crm.deal.recurring.fields
filter `object`	Объект фильтра формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n, }` где: `field_n` — название поля, по которому будет отфильтрована выборка элементов `value_n` — значение фильтра К ключам `field_n` можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN, в качестве значения передается массив `!@` — NOT IN, в качестве значения передается массив `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: `"мол%"` — ищет значения, начинающиеся с «мол» `"%мол"` — ищет значения, заканчивающиеся на «мол» `"%мол%"` — ищет значения, где «мол» может быть в любой позиции `%=` — LIKE (аналогично `=%`) `=` — равно, точное совпадение (используется по умолчанию) `!=` — не равно `!` — не равно Список полей для фильтрации можно получить методом crm.deal.recurring.fields. Поле `PARAMS` в фильтре игнорируется и не влияет на результат выборки
start `integer`	Параметр постраничной навигации. Размер страницы фиксирован: `50` записей. Формула для получения N-й страницы: `start = (N - 1) * 50`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"deal_id":"ASC"},"filter":{">COUNTER_REPEAT":0}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"deal_id":"ASC"},"filter":{">COUNTER_REPEAT":0},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.recurring.list

// callListMethod: получает все данные сразу. Подходит для небольших выборок.
        try {
          const response = await $b24.callListMethod(
            'crm.deal.recurring.list',
            {
              order: { deal_id: 'ASC' },
              filter: { '>COUNTER_REPEAT': 0 }
            }
          );
          const items = response.getData() || [];
          for (const item of items) {
            console.log(item);
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: выбирает данные по частям (итератор).
        try {
          const iterator = $b24.fetchListMethod(
            'crm.deal.recurring.list',
            {
              order: { deal_id: 'ASC' },
              filter: { '>COUNTER_REPEAT': 0 }
            },
            'id'
          );
          for await (const page of iterator) {
            for (const item of page) {
              console.log(item);
            }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: ручная пагинация через параметр start.
        try {
          const response = await $b24.callMethod(
            'crm.deal.recurring.list',
            {
              order: { deal_id: 'ASC' },
              filter: { '>COUNTER_REPEAT': 0 }
            },
            0
          );
          const result = response.getData().result || [];
          for (const item of result) {
            console.log(item);
          }
        } catch (error) {
          console.error('Request failed', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.list',
                    [
                        'order' => ['deal_id' => 'ASC'],
                        'filter' => ['>COUNTER_REPEAT' => 0],
                    ]
                );
        
            $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 deals: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.recurring.list',
            {
                order: { deal_id: 'ASC' },
                filter: { '>COUNTER_REPEAT': 0 }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                    if (result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.list',
            [
                'order' => ['deal_id' => 'ASC'],
                'filter' => ['>COUNTER_REPEAT' => 0],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                    "id": "1",
                    "deal_id": "575",
                    "based_id": "573",
                    "ACTIVE": "N",
                    "category_id": "1",
                    "IS_LIMIT": "T",
                    "COUNTER_REPEAT": "2",
                    "LIMIT_REPEAT": "2",
                    "LIMIT_DATE": "",
                    "START_DATE": "2020-06-15T03:00:00+03:00",
                    "NEXT_EXECUTION": "",
                    "LAST_EXECUTION": "2020-06-17T01:00:00+03:00",
                    "PARAMS": {
                        "MODE": "multiple",
                        "SINGLE_BEFORE_START_DATE_TYPE": "day",
                        "SINGLE_BEFORE_START_DATE_VALUE": 0,
                        "MULTIPLE_TYPE": "day",
                        "MULTIPLE_INTERVAL": 1,
                        "OFFSET_BEGINDATE_TYPE": "day",
                        "OFFSET_BEGINDATE_VALUE": 1,
                        "OFFSET_CLOSEDATE_TYPE": "day",
                        "OFFSET_CLOSEDATE_VALUE": 1
                    }
                },
                {
                    "id": "5",
                    "deal_id": "6555",
                    "based_id": "6531",
                    "ACTIVE": "Y",
                    "category_id": "9",
                    "IS_LIMIT": "N",
                    "COUNTER_REPEAT": "471",
                    "LIMIT_REPEAT": null,
                    "LIMIT_DATE": "",
                    "START_DATE": "2024-11-21T03:00:00+03:00",
                    "NEXT_EXECUTION": "2026-03-07T01:00:00+03:00",
                    "LAST_EXECUTION": "2026-03-06T01:00:00+03:00",
                    "PARAMS": {
                        "MODE": "multiple",
                        "SINGLE_BEFORE_START_DATE_TYPE": "day",
                        "SINGLE_BEFORE_START_DATE_VALUE": 0,
                        "MULTIPLE_TYPE": "day",
                        "MULTIPLE_INTERVAL": 1,
                        "OFFSET_BEGINDATE_TYPE": "day",
                        "OFFSET_BEGINDATE_VALUE": 0,
                        "OFFSET_CLOSEDATE_TYPE": "day",
                        "OFFSET_CLOSEDATE_VALUE": 0
                    }
                }
            ],
            "total": 5,
            "time": {
                "start": 1772757008,
                "finish": 1772757008.649235,
                "duration": 0.6492350101470947,
                "processing": 0,
                "date_start": "2026-03-06T03:30:08+03:00",
                "date_finish": "2026-03-06T03:30:08+03:00",
                "operating_reset_at": 1772757608,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `recurring_deal[]`	Массив настроек шаблонов регулярных сделок. Описание полей элемента приведено в методе crm.deal.recurring.get
total `integer`	Общее количество найденных записей
next `integer`	Смещение для запроса следующей страницы. Поле присутствует, если есть следующая страница результатов
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

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

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

Код	Описание
`Access denied`	Недостаточно прав для чтения сделок
`Parameter 'order' must be array`	В параметр `order` передан не объект
`Parameter 'filter' must be array`	В параметр `filter` передан не объект
`Failed to get list. General error`	Не удалось получить список из-за внутренней ошибки

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

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.list

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

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

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

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

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

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

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

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