Получить список банковских реквизитов по фильтру crm.requisite.bankdetail.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод возвращает список банковских реквизитов по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив содержит список полей, которые необходимо выбрать (смотрите поля банковского реквизита). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля банковских реквизитов |
|
filter |
Объект для фильтрации выбранных банковских реквизитов в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных банковских реквизитов в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Описание полей банковского реквизита
|
Название |
Описание |
|
ID |
Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала |
|
ENTITY_ID |
Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита. Идентификаторы реквизитов можно получить с помощью метода |
|
COUNTRY_ID |
Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений). Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле |
|
DATE_CREATE |
Дата создания |
|
DATE_MODIFY |
Дата изменения |
|
CREATED_BY_ID |
Идентификатор пользователя, создавшего реквизит |
|
MODIFY_BY_ID |
Идентификатор пользователя, изменившего реквизит |
|
NAME |
Название банковского реквизита |
|
CODE |
Символьный код реквизита |
|
XML_ID |
Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле. Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями |
|
ACTIVE |
Признак активности. Используются значения Сейчас поле фактически ни на что не влияет |
|
SORT |
Сортировка |
|
RQ_BANK_NAME |
Наименование банка |
|
RQ_BANK_ADDR |
Адрес банка |
|
RQ_BANK_CODE |
Código do banco (для страны BR) |
|
RQ_BANK_ROUTE_NUM |
Bank Routing Number |
|
RQ_BIK |
БИК |
|
RQ_CODEB |
Code Banque (для страны FR) |
|
RQ_CODEG |
Code Guichet (для страны FR) |
|
RQ_RIB |
Clé RIB (для страны FR) |
|
RQ_MFO |
МФО |
|
RQ_ACC_NAME |
Bank Account Holder Name |
|
RQ_ACC_NUM |
Bank Account Number |
|
RQ_ACC_TYPE |
Tipo da conta (для страны BR) |
|
RQ_AGENCY_NAME |
Agência (для страны BR) |
|
RQ_IIK |
ИИК |
|
RQ_ACC_CURRENCY |
Валюта счета |
|
RQ_COR_ACC_NUM |
Корреспондентский счет |
|
RQ_IBAN |
IBAN |
|
RQ_SWIFT |
SWIFT |
|
RQ_BIC |
BIC |
|
COMMENTS |
Комментарий |
|
ORIGINATOR_ID |
Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком |
Примеры кода
Как использовать примеры в документации
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>
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>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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}")
Пример as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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}")
Пример as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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}")
Обработка ответа
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 |
Массив объектов с информацией из выбранных банковских реквизитов. Каждый элемент содержит выбранные поля банковского реквизита |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 40x, 50x
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные ошибки
|
Текст ошибки |
Описание |
|
|
Недостаточно прав доступа для получения списка банковских реквизитов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый банковский реквизит crm.requisite.bankdetail.add
- Изменить банковский реквизит crm.requisite.bankdetail.update
- Получить банковский реквизит по id crm.requisite.bankdetail.get
- Удалить банковский реквизит crm.requisite.bankdetail.delete
- Получить описание полей банковских реквизитов crm.requisite.bankdetail.fields