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

`POST /v1/bank-details/search`

Поиск банковских реквизитов с фильтрами и авто-пагинацией. Аналогичен `GET /v1/bank-details`, но параметры передаются в теле запроса — подходит для сложных фильтров с большим количеством условий и для программной сборки запросов.

## Поля запроса (body)

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` | object | — | Фильтрация по полям `GET /v1/bank-details/fields`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `{ "entityId": 3, "active": true }` |
| `limit` | number | `50` | Количество записей (до 5000) |
| `offset` | number | `0` | Пропустить N записей. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. `UNSTABLE_OFFSET_PAGINATION` в разделе «Ошибки» |
| `order` | object | — | Сортировка: `{ "id": "desc" }` |
| `select` | string[] | — | Выборка полей: `["id", "name", "rqBik", "rqAccNum"]` |
| `autoWindow` | boolean | `true` | Разбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. `false` отключает разбиение |

## Примеры

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/bank-details/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": 3, "active": true },
    "limit": 20,
    "order": { "id": "asc" }
  }'
```

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

```bash
curl -X POST "https://vibecode.bitrix24.tech/v1/bank-details/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": 3, "active": true },
    "limit": 20,
    "order": { "id": "asc" }
  }'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 3, active: true },
    limit: 20,
    order: { id: 'asc' },
  }),
})

const { success, data } = await res.json()
console.log('Найдено:', data.length)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 3, active: true },
    limit: 20,
    order: { id: 'asc' },
  }),
})

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

### Другие сценарии

Все банковские реквизиты одного реквизита:

```json
{ "filter": { "entityId": 11 } }
```

Фильтр по БИК:

```json
{ "filter": { "rqBik": "13142323452" } }
```

С выборкой конкретных полей:

```json
{
  "filter": { "active": true },
  "select": ["id", "entityId", "name", "rqBik", "rqAccNum"],
  "order": { "id": "asc" }
}
```

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

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

Поля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `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
  }
}
```

С фильтром по диапазону дат шире 14 дней в `meta` дополнительно приходят `autoWindowed`, `windowCount` и `batchWaves`:

```json
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 2,
    "hasMore": false,
    "autoWindowed": true,
    "windowCount": 131,
    "batchWaves": 3,
    "durationMs": 1497
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` с сортировкой по `id`, либо режьте диапазон дат на части сами |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 400 | `INVALID_FILTER` | Ошибка в синтаксисе фильтра |

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

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

**Разбиение по временны́м окнам.** Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В `meta` тогда приходят `autoWindowed: true`, число окон `windowCount` и число волн `batchWaves`. Отключает разбиение параметр `autoWindow: false`. При активном разбиении `offset` больше нуля отклоняется с `UNSTABLE_OFFSET_PAGINATION`.

**`entityTypeId` не возвращается в ответе.** Это поле передаётся только при создании. В ответах поиска поле отсутствует — фильтровать по `entityId` (ID реквизита-владельца).

**Пагинация.** При `limit > 50` запрос автоматически разбивается на несколько вызовов к Битрикс24. Для больших выборок используйте `offset` и постраничные запросы.

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

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