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

`GET /v1/requisite-links/fields`

Возвращает схему связи реквизита — описание, типы и флаги для всех шести полей. Здесь же справочник значений `entityTypeId` — типов сущности, к которой привязывают реквизит.

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/requisite-links/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/requisite-links/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/requisite-links/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `success` | boolean | RO | Всегда `true` при успехе |
| `data.fields` | object | RO | Схема связи. Ключи — имена полей в camelCase |
| `data.fields.entityTypeId` | object | RO | Тип сущности-владельца. Значения — в справочнике ниже |
| `data.fields.entityId` | object | RO | ID сущности-владельца |
| `data.fields.requisiteId` | object | RO | ID реквизита клиента, `0` — не привязан |
| `data.fields.bankDetailId` | object | RO | ID банковского реквизита клиента, `0` — не привязан |
| `data.fields.mcRequisiteId` | object | RO | ID реквизита вашей компании, `0` — не привязан |
| `data.fields.mcBankDetailId` | object | RO | ID банковского реквизита вашей компании, `0` — не привязан |

Каждый объект-поле содержит `type`, `isRequired`, `isReadOnly`, `isImmutable`, `isMultiple`, `isDynamic` и `title`.

Значения `title` платформа берёт напрямую с портала, поэтому они приходят на языке портала. Заголовками запроса язык не переключается.

### Справочник типов владельца

Значение `entityTypeId` определяет, к какой сущности привязывается реквизит. Одно и то же значение используется в пути, в теле регистрации и в фильтре списка.

| `entityTypeId` | Владелец | Где взять `entityId` |
|---------------|----------|---------------------|
| `2` | Сделка | [`GET /v1/deals`](/docs/entities/deals/list) |
| `5` | Счёт старого образца | Отдельного эндпоинта в API Вайбкод нет |
| `7` | Предложение | [`GET /v1/quotes`](/docs/entities/quotes/list) |
| `31` | Счёт | [`GET /v1/invoices`](/docs/entities/invoices/list) |
| Код смарт-процесса | Элемент смарт-процесса | [`GET /v1/items/:entityTypeId`](/docs/entities/items/list) |

Коды смарт-процессов различаются от портала к порталу. Действующие коды возвращает [`GET /v1/smart-processes`](/docs/entities/smart-processes/list) — поле `entityTypeId` каждого смарт-процесса.

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "entityTypeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID типа сущности"
      },
      "entityId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID сущности"
      },
      "requisiteId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к реквизитам"
      },
      "bankDetailId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к банковским реквизитам"
      },
      "mcRequisiteId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к реквизитам моей компании"
      },
      "mcBankDetailId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к банковским реквизитам моей компании"
      }
    }
  }
}
```

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

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

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

## Ошибки

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

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

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

**`isRequired: true` относится к ключу, а не к самой привязке.** Флаг означает, что при регистрации связи ключ обязан присутствовать в теле запроса. Значение `0` при этом допустимо и сохраняется: связь, у которой все четыре привязки равны `0`, регистрируется и возвращает `201`.

**Схема одна на все типы владельцев.** Набор полей не зависит от `entityTypeId` — у сделки, счёта и элемента смарт-процесса он одинаковый.

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

- [Зарегистрировать связь](/docs/entities/requisite-links/register)
- [Список связей](/docs/entities/requisite-links/list)
- [Entity API](/docs/entity-api)