## Поля банковского реквизита

`GET /v1/bank-details/fields`

Возвращает схему всех полей сущности банковского реквизита: типы, признак «только для чтения» и обязательность.

## Формат ответа

Каждое поле в `data.fields` содержит:

| Ключ | Тип | Описание |
|------|-----|---------|
| `type` | string | Тип значения: `number`, `string`, `boolean`, `datetime` |
| `readonly` | boolean | `true` — поле не принимается при создании и обновлении |
| `required` | boolean | `true` — поле обязательно при создании (присутствует только когда `true`) |
| `label` | string | Название поля для отображения, на русском языке |
| `description` | string | Пояснение к полю на русском языке |

Заголовками запроса язык подписей и описаний не переключается.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/bank-details/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/bank-details/fields" \
  -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/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Все поля:', Object.keys(data.fields))
```

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

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

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

## Поля из схемы Вайбкод

Поле `entityTypeId` помечено `notReturned: true`: оно принимается при записи, но не приходит в ответах. Явный `select=entityTypeId` возвращает предупреждение `UNKNOWN_SELECT_FIELD`, а поле не попадает в ответ. Не добавляйте его в `select`.

### Служебные

| Поле | Битрикс24 | Тип | RO | Описание |
|------|-----------|-----|:--:|---------|
| `id` | `ID` | number | да | Идентификатор банковского реквизита |
| `entityTypeId` | `ENTITY_TYPE_ID` | number | нет | Тип сущности-владельца. Всегда `8` (реквизит). Только для записи — в ответе `get` не возвращается |
| `entityId` | `ENTITY_ID` | number | нет | ID реквизита-владельца |
| `countryId` | `COUNTRY_ID` | number | нет | ID страны. `0` — страна не указана |
| `name` | `NAME` | string | нет | Название банковского реквизита |
| `code` | `CODE` | string | нет | Символьный код для внешних интеграций |
| `xmlId` | `XML_ID` | string | нет | Внешний идентификатор для синхронизации |
| `originatorId` | `ORIGINATOR_ID` | string | нет | ID системы-источника |
| `active` | `ACTIVE` | boolean | нет | Активна ли запись |
| `sort` | `SORT` | number | нет | Порядок сортировки |
| `comments` | `COMMENTS` | string | нет | Комментарий к записи |
| `createdAt` | `DATE_CREATE` | datetime | да | Дата создания (ISO 8601) |
| `updatedAt` | `DATE_MODIFY` | datetime | да | Дата последнего изменения (ISO 8601) |
| `createdBy` | `CREATED_BY_ID` | number | да | ID создателя |
| `modifyBy` | `MODIFY_BY_ID` | number | да | ID последнего редактора |

### Банковские реквизиты

| Поле | Битрикс24 | Тип | RO | Описание |
|------|-----------|-----|:--:|---------|
| `rqBankName` | `RQ_BANK_NAME` | string | нет | Наименование банка |
| `rqBankAddr` | `RQ_BANK_ADDR` | string | нет | Адрес банка |
| `rqBankRouteNum` | `RQ_BANK_ROUTE_NUM` | string | нет | Маршрутный номер банка |
| `rqBankCode` | `RQ_BANK_CODE` | string | нет | Код банка |
| `rqBik` | `RQ_BIK` | string | нет | БИК |
| `rqMfo` | `RQ_MFO` | string | нет | МФО (Украина) |
| `rqAccName` | `RQ_ACC_NAME` | string | нет | Наименование счёта |
| `rqAccNum` | `RQ_ACC_NUM` | string | нет | Расчётный счёт |
| `rqAccType` | `RQ_ACC_TYPE` | string | нет | Тип счёта |
| `rqCorAccNum` | `RQ_COR_ACC_NUM` | string | нет | Корреспондентский счёт |
| `rqAccCurrency` | `RQ_ACC_CURRENCY` | string | нет | Валюта счёта |
| `rqIik` | `RQ_IIK` | string | нет | ИИК (Казахстан) |
| `rqAgencyName` | `RQ_AGENCY_NAME` | string | нет | Наименование агентства |

### Международные реквизиты

| Поле | Битрикс24 | Тип | RO | Описание |
|------|-----------|-----|:--:|---------|
| `rqIban` | `RQ_IBAN` | string | нет | IBAN |
| `rqSwift` | `RQ_SWIFT` | string | нет | SWIFT-код |

### Реквизиты Франции

| Поле | Битрикс24 | Тип | RO | Описание |
|------|-----------|-----|:--:|---------|
| `rqBic` | `RQ_Bic` | string | нет | BIC (французская форма; отличается от `rqBik`) |
| `rqCodeb` | `RQ_CODEB` | string | нет | Код банка (Франция) |
| `rqCodeg` | `RQ_CODEG` | string | нет | Код гуйше (Франция) |
| `rqRib` | `RQ_RIB` | string | нет | RIB (Франция) |

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false, "notReturned": true },
      "entityId": { "type": "number", "readonly": false, "required": true },
      "countryId": { "type": "number", "readonly": false },
      "name": { "type": "string", "readonly": false, "required": true },
      "code": { "type": "string", "readonly": false },
      "xmlId": { "type": "string", "readonly": false },
      "originatorId": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "comments": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "updatedAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },
      "modifyBy": { "type": "number", "readonly": true },
      "rqBankName": { "type": "string", "readonly": false },
      "rqBankAddr": { "type": "string", "readonly": false },
      "rqBankRouteNum": { "type": "string", "readonly": false },
      "rqBankCode": { "type": "string", "readonly": false },
      "rqAccNum": { "type": "string", "readonly": false },
      "rqCorAccNum": { "type": "string", "readonly": false },
      "rqIik": { "type": "string", "readonly": false },
      "rqMfo": { "type": "string", "readonly": false },
      "rqAccName": { "type": "string", "readonly": false },
      "rqAccCurrency": { "type": "string", "readonly": false },
      "rqBik": { "type": "string", "readonly": false },
      "rqSwift": { "type": "string", "readonly": false },
      "rqIban": { "type": "string", "readonly": false },
      "rqAgencyName": { "type": "string", "readonly": false },
      "rqAccType": { "type": "string", "readonly": false },
      "rqBic": { "type": "string", "readonly": false },
      "rqCodeb": { "type": "string", "readonly": false },
      "rqCodeg": { "type": "string", "readonly": false },
      "rqRib": { "type": "string", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm`. Требуется: `This endpoint requires 'crm' scope` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

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

- [Получить банковский реквизит](/docs/entities/bank-details/get)
- [Список банковских реквизитов](/docs/entities/bank-details/list)
- [Создать банковский реквизит](/docs/entities/bank-details/create)
- [Реквизиты](/docs/entities/requisites)