Получить список банковских реквизитов по фильтру crm.requisite.bankdetail.list

Scope: crm

Кто может выполнять метод: любой пользователь

Метод возвращает список банковских реквизитов по фильтру.

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

Название `тип`	Описание
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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.requisite.bankdetail.list',
            {
              order: { "DATE_CREATE": "ASC" },
              filter: { "COUNTRY_ID": "1" },
              select: [ "ENTITY_ID", "ID", "NAME" ]
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('crm.requisite.bankdetail.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COUNTRY_ID": "1" },
            select: [ "ENTITY_ID", "ID", "NAME" ]
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.requisite.bankdetail.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COUNTRY_ID": "1" },
            select: [ "ENTITY_ID", "ID", "NAME" ]
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', 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>';

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

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`	Информация о времени выполнения запроса

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

HTTP-статус: 40x, 50x

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

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

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

Текст ошибки	Описание
`Access denied`	Недостаточно прав доступа для получения списка банковских реквизитов

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

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

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

Описание полей банковского реквизитаОписание полей банковского реквизита

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

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

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

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

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

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

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