crm.deal.recurring.list
Получить список настроек шаблонов регулярных сделок
Описание
Метод 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 -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
// 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 each recurring-deal setting returned in result[]
type CrmDealRecurringListItem = {
id: string
deal_id: string
based_id: string
ACTIVE: string
category_id: string
IS_LIMIT: string
COUNTER_REPEAT: string
LIMIT_REPEAT: string | null
LIMIT_DATE: ISODate | null
START_DATE: ISODate | null
NEXT_EXECUTION: ISODate | null
LAST_EXECUTION: ISODate | null
}
try {
// crm.deal.recurring.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CrmDealRecurringListItem[]>({
method: 'crm.deal.recurring.list',
params: {
order: {
deal_id: 'ASC',
},
filter: {
'>COUNTER_REPEAT': 0,
},
start: 0,
},
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 templates on this page:', result.length, 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 listRecurringDeals() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.deal.recurring.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.recurring.list',
params: {
order: {
deal_id: 'ASC',
},
filter: {
'>COUNTER_REPEAT': 0,
},
start: 0,
},
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 templates on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listRecurringDeals)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.recurring.list(select=[
"ID",
"DEAL_ID",
"ACTIVE",
"NEXT_EXECUTION",
"IS_LIMIT",
], filter={
"=ACTIVE": "Y",
">COUNTER_REPEAT": 0,
}, order={
"ID": "DESC",
"deal_id": "ASC",
}, start=0).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.recurring.list(
select=[
"ID",
"DEAL_ID",
"ACTIVE",
],
filter={
"=ACTIVE": "Y",
},
order={
"ID": "ASC",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.recurring.list(
select=[
"ID",
"DEAL_ID",
"ACTIVE",
],
filter={
"=ACTIVE": "Y",
},
order={
"ID": "DESC",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.recurring.list", b24.Params{
"order": b24.Params{
"deal_id": "ASC",
},
"filter": b24.Params{
">COUNTER_REPEAT": 0,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.recurring.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
DealID string `json:"deal_id"`
BasedID string `json:"based_id"`
Active string `json:"ACTIVE"`
CategoryID string `json:"category_id"`
IsLimit string `json:"IS_LIMIT"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.DealID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
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."
}
| Код | Описание | Значение |
|---|---|---|
Access denied |
Недостаточно прав для чтения сделок | |
Parameter 'order' must be array |
В параметр order передан не объект |
|
Parameter 'filter' must be array |
В параметр filter передан не объект |
|
Failed to get list. General error |
Не удалось получить список из-за внутренней ошибки |

