For AI agents: markdown of this page — /docs-content-en/entities/requisite-links/fields.md documentation index — /llms.txt

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

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

curl — OAuth application

Terminal 
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
Fieldsuccess Typeboolean RORO DescriptionAlways true on success
Fielddata.fields Typeobject RORO DescriptionLink schema. Keys are field names in camelCase
Fielddata.fields.entityTypeId Typeobject RORO DescriptionOwner entity type. Values are listed in the reference below
Fielddata.fields.entityId Typeobject RORO DescriptionOwner entity ID
Fielddata.fields.requisiteId Typeobject RORO DescriptionClient requisite ID, 0 — not linked
Fielddata.fields.bankDetailId Typeobject RORO DescriptionClient bank detail ID, 0 — not linked
Fielddata.fields.mcRequisiteId Typeobject RORO DescriptionYour company's requisite ID, 0 — not linked
Fielddata.fields.mcBankDetailId Typeobject RORO DescriptionYour 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
entityTypeId2 OwnerDeal Where to get entityIdGET /v1/deals
entityTypeId5 OwnerLegacy invoice Where to get entityIdThere is no separate endpoint in the Vibecode API
entityTypeId7 OwnerQuote Where to get entityIdGET /v1/quotes
entityTypeId31 OwnerInvoice Where to get entityIdGET /v1/invoices
entityTypeIdSmart process code OwnerSmart process item Where to get entityIdGET /v1/items/:entityTypeId

Smart process codes differ from one Bitrix24 account to another. The codes currently in use are returned by GET /v1/smart-processes — 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
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — 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