метод REST scope: crm

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

Ответ

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 Недостаточно прав доступа для получения списка банковских реквизитов

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.