## Список банковских реквизитов

`GET /v1/bank-details`

Возвращает список банковских реквизитов с поддержкой фильтрации, сортировки и авто-пагинации. Банковский реквизит всегда принадлежит конкретному реквизиту — для получения реквизитов конкретного реквизита передавайте фильтр по `entityId`.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей (до 5000). При `limit > 50` Вайбкод автоматически запрашивает несколько страниц у Битрикс24 |
| `offset` | number | `0` | Пропустить N записей. При `offset ≥ 2500` рекомендуется `limit ≤ 500` |
| `select` | string | — | Выборка полей: `?select=id,name,rqBik,rqAccNum` |
| `sort` | string | — | Сортировка кратким синтаксисом: `?sort=-id`, минус означает убывание. Несколько полей — через запятую: `?sort=-id,name` |
| `order` | object | — | Сортировка: `?order[id]=desc`. Если переданы и `sort`, и `order`, применяется `sort` |
| `filter` | object | — | Фильтрация по полям `GET /v1/bank-details/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[entityId]=3` |

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/bank-details?filter[entityId]=3" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/bank-details?filter[entityId]=3" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details?filter[entityId]=3', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} банковских реквизитов`)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details?filter[entityId]=3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив банковских реквизитов (все поля — см. [Поля банковского реквизита](/docs/entities/bank-details/fields)) |
| `meta.total` | number | Общее количество записей, соответствующих фильтру |
| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |

## Пример ответа

```json
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityId": 3,
      "countryId": 1,
      "name": "Банковские реквизиты 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "Реквизиты 1",
      "rqBankAddr": null,
      "rqBik": null,
      "rqAccNum": null,
      "rqCorAccNum": null,
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-05-22T11:56:53.000Z",
      "updatedAt": "2023-12-05T11:50:19.000Z",
      "createdBy": 1,
      "modifyBy": 779
    },
    {
      "id": 5,
      "entityId": 11,
      "countryId": 1,
      "name": "Банковские реквизиты 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "банк",
      "rqBankAddr": "тестовый адрес",
      "rqBik": "13142323452",
      "rqAccNum": "234245746878032451534",
      "rqCorAccNum": "235134524566748725431",
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-06-30T09:53:58.000Z",
      "updatedAt": null,
      "createdBy": 1,
      "modifyBy": null
    }
  ],
  "meta": {
    "total": 6,
    "hasMore": true
  }
}
```

## Пример ответа при ошибке

403 — нет скоупа:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 400 | `INVALID_FILTER` | Ошибка в синтаксисе фильтра |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**`entityTypeId` не возвращается в ответе.** Это поле передаётся только при создании. В ответах `GET /v1/bank-details` и `GET /v1/bank-details/:id` поле отсутствует.

**`countryId = 0` при отсутствии страны.** Если страна не указана, поле `countryId` возвращается как `0`, а не `null`.

**Авто-пагинация.** При `limit > 50` Вайбкод автоматически запрашивает несколько страниц у Битрикс24 и возвращает все записи в одном ответе.

## Смотрите также

- [Поиск банковских реквизитов](/docs/entities/bank-details/search)
- [Поля банковского реквизита](/docs/entities/bank-details/fields)
- [Реквизиты](/docs/entities/requisites)
- [Синтаксис фильтрации](/docs/filtering)
- [Entity API](/docs/entity-api)
- [Batch](/docs/batch)