## Requisite link fields

`GET /v1/requisite-links/fields`

Returns the requisite link schema — descriptions, types and flags for all six fields. This page also lists the `entityTypeId` values — the entity types a requisite can be linked to.

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/requisite-links/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-links/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields))
```

### JavaScript — OAuth application

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

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

## Response fields

| Field | Type | RO | Description |
|------|-----|:--:|---------|
| `success` | boolean | RO | Always `true` on success |
| `data.fields` | object | RO | Link schema. Keys are field names in camelCase |
| `data.fields.entityTypeId` | object | RO | Owner entity type. Values are listed in the reference below |
| `data.fields.entityId` | object | RO | Owner entity ID |
| `data.fields.requisiteId` | object | RO | Client requisite ID, `0` — not linked |
| `data.fields.bankDetailId` | object | RO | Client bank detail ID, `0` — not linked |
| `data.fields.mcRequisiteId` | object | RO | Your company's requisite ID, `0` — not linked |
| `data.fields.mcBankDetailId` | object | RO | Your company's bank detail ID, `0` — not linked |

Each field object contains `type`, `isRequired`, `isReadOnly`, `isImmutable`, `isMultiple`, `isDynamic` and `title`.

The `title` values come straight from the Bitrix24 account, so they are returned in the account language. Request headers do not switch the language.

### Owner type reference

The `entityTypeId` value defines which entity the requisite is linked to. The same value is used in the path, in the register request body and in the list filter.

| `entityTypeId` | Owner | Where to get `entityId` |
|---------------|----------|---------------------|
| `2` | Deal | [`GET /v1/deals`](/docs/entities/deals/list) |
| `5` | Legacy invoice | There is no separate endpoint in the Vibecode API |
| `7` | Quote | [`GET /v1/quotes`](/docs/entities/quotes/list) |
| `31` | Invoice | [`GET /v1/invoices`](/docs/entities/invoices/list) |
| Smart process code | Smart process item | [`GET /v1/items/:entityTypeId`](/docs/entities/items/list) |

Smart process codes differ from one Bitrix24 account to another. The codes currently in use are returned by [`GET /v1/smart-processes`](/docs/entities/smart-processes/list) — the `entityTypeId` field of each smart process.

## Response example

```json
{
  "success": true,
  "data": {
    "fields": {
      "entityTypeId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Entity type ID"
      },
      "entityId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Entity ID"
      },
      "requisiteId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Requisite link"
      },
      "bankDetailId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Bank requisite link"
      },
      "mcRequisiteId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "My company requisite link"
      },
      "mcBankDetailId": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "My company bank requisite link"
      }
    }
  }
}
```

## Error response example

403 — no scope:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**`isRequired: true` applies to the key, not to the link itself.** The flag means that the key must be present in the request body when a link is registered. The value `0` is still allowed and is stored: a link whose four identifiers are all `0` is registered and returns `201`.

**One schema for all owner types.** The field set does not depend on `entityTypeId` — it is the same for a deal, an invoice and a smart process item.

## See also

- [Register a link](/docs/entities/requisite-links/register)
- [List links](/docs/entities/requisite-links/list)
- [Entity API](/docs/entity-api)