crm.requisite.bankdetail.list
Получить список банковских реквизитов по фильтру
Описание
Метод возвращает список банковских реквизитов по фильтру.
Параметры
select
array
необязательный
Массив содержит список полей, которые необходимо выбрать (смотрите поля банковского реквизита).
Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля банковских реквизитов
filter
object
необязательный
Объект для фильтрации выбранных банковских реквизитов в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям банковского реквизита.
Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
order
object
необязательный
Объект для сортировки выбранных банковских реквизитов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям банковского реквизита.
Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Описание полей банковского реквизита
ID
integer
необязательный
Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала
ENTITY_ID
integer
необязательный
Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита.
Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list
COUNTRY_ID
integer
необязательный
Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений).
Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле ENTITY_ID
DATE_CREATE
datetime
необязательный
Дата создания
DATE_MODIFY
datetime
необязательный
Дата изменения
CREATED_BY_ID
user
необязательный
Идентификатор пользователя, создавшего реквизит
MODIFY_BY_ID
user
необязательный
Идентификатор пользователя, изменившего реквизит
NAME
string
необязательный
Название банковского реквизита
CODE
string
необязательный
Символьный код реквизита
XML_ID
string
необязательный
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.
Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле.
Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями
ACTIVE
char
необязательный
Признак активности. Используются значения Y или N.
Сейчас поле фактически ни на что не влияет
SORT
integer
необязательный
Сортировка
RQ_BANK_NAME
string
необязательный
Наименование банка
RQ_BANK_ADDR
string
необязательный
Адрес банка
RQ_BANK_CODE
string
необязательный
Código do banco (для страны BR)
RQ_BANK_ROUTE_NUM
string
необязательный
Bank Routing Number
RQ_BIK
string
необязательный
БИК
RQ_CODEB
string
необязательный
Code Banque (для страны FR)
RQ_CODEG
string
необязательный
Code Guichet (для страны FR)
RQ_RIB
string
необязательный
Clé RIB (для страны FR)
RQ_MFO
string
необязательный
МФО
RQ_ACC_NAME
string
необязательный
Bank Account Holder Name
RQ_ACC_NUM
string
необязательный
Bank Account Number
RQ_ACC_TYPE
string
необязательный
Tipo da conta (для страны BR)
RQ_AGENCY_NAME
string
необязательный
Agência (для страны BR)
RQ_IIK
string
необязательный
ИИК
RQ_ACC_CURRENCY
string
необязательный
Валюта счета
RQ_COR_ACC_NUM
string
необязательный
Корреспондентский счет
RQ_IBAN
string
необязательный
IBAN
RQ_SWIFT
string
необязательный
SWIFT
RQ_BIC
string
необязательный
BIC
COMMENTS
string
необязательный
Комментарий
ORIGINATOR_ID
string
необязательный
Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_CREATE":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ENTITY_ID","ID","NAME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_CREATE":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ENTITY_ID","ID","NAME"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each bank detail item returned in result[]
type BankDetailItem = {
ID: string
ENTITY_ID: string
NAME: string
}
try {
// crm.requisite.bankdetail.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<BankDetailItem[]>({
method: 'crm.requisite.bankdetail.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ENTITY_ID', 'ID', 'NAME'],
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('Bank details count:', result.length, 'Items:', 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 listBankDetails() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.bankdetail.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.requisite.bankdetail.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ENTITY_ID', 'ID', 'NAME'],
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('Bank details count:', result.length, 'Items:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listBankDetails)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.bankdetail.list(
order={
"DATE_CREATE": "ASC",
},
filter={
"COUNTRY_ID": "1",
},
select=[
"ENTITY_ID",
"ID",
"NAME",
],
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.requisite.bankdetail.list(
order={
"DATE_CREATE": "ASC",
},
filter={
"COUNTRY_ID": "1",
},
select=[
"ENTITY_ID",
"ID",
"NAME",
],
).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.requisite.bankdetail.list(
filter={
"COUNTRY_ID": "1",
},
select=[
"ENTITY_ID",
"ID",
"NAME",
],
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.requisite.bankdetail.list',
[
'order' => ['DATE_CREATE' => 'ASC'],
'filter' => ['COUNTRY_ID' => '1'],
'select' => ['ENTITY_ID', 'ID', 'NAME'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($result->more()) {
$result->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing bank details: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.bankdetail.list",
{
order: { "DATE_CREATE": "ASC" },
filter: { "COUNTRY_ID": "1" },
select: [ "ENTITY_ID", "ID", "NAME" ]
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.dir(result.data());
if(result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.bankdetail.list',
[
'order' => ['DATE_CREATE' => 'ASC'],
'filter' => ['COUNTRY_ID' => '1'],
'select' => ['ENTITY_ID', 'ID', 'NAME']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.requisite.bankdetail.list", b24.Params{
"order": b24.Params{
"DATE_CREATE": "ASC",
},
"filter": b24.Params{
"COUNTRY_ID": "1",
},
"select": []string{"ENTITY_ID", "ID", "NAME"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.bankdetail.list: %w", err)
}
var items []struct {
EntityID b24.ID `json:"ENTITY_ID"`
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.EntityID, it.ID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ENTITY_ID": "27",
"ID": "11",
"NAME": "Тинькофф"
},
{
"ENTITY_ID": "30",
"ID": "15",
"NAME": "АО \"АЛЬФА-БАНК\""
},
{
"ENTITY_ID": "30",
"ID": "16",
"NAME": "АО \"Тинькофф Банк\""
},
{
"ENTITY_ID": "45",
"ID": "17",
"NAME": "АО \"Тинькофф Банк\""
},
{
"ENTITY_ID": "45",
"ID": "18",
"NAME": "АО \"АЛЬФА-БАНК\""
}
],
"total": 5,
"time": {
"start": 1717498684.70562,
"finish": 1717498685.13295,
"duration": 0.42733001708984375,
"processing": 0.020370006561279297,
"date_start": "2024-06-04T12:58:04+02:00",
"date_finish": "2024-06-04T12:58:05+02:00",
"operating": 0
}
}
Возвращаемые данные
result
array
Массив объектов с информацией из выбранных банковских реквизитов. Каждый элемент содержит выбранные поля банковского реквизита
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "Access denied."
}
| Код | Описание | Значение |
|---|---|---|
Access denied |
Недостаточно прав доступа для получения списка банковских реквизитов |

