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

GET /v1/requisite-links/fields

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

Примеры

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

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

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

Terminal 
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 Всегда true при успехе
data.fields object Схема полей. Ключи — имена в UPPER_SNAKE_CASE
data.fields.ENTITY_TYPE_ID object Тип владельца связи: 2 — сделка, 31 — счёт
data.fields.ENTITY_ID object ID сущности-владельца
data.fields.REQUISITE_ID object ID реквизита клиента; "0" — не привязан
data.fields.BANK_DETAIL_ID object ID банковского реквизита клиента; "0" — не привязан
data.fields.MC_REQUISITE_ID object ID реквизита вашей компании; "0" — не привязан
data.fields.MC_BANK_DETAIL_ID object ID банковского реквизита вашей компании; "0" — не привязан

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

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "ENTITY_TYPE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID типа сущности"
      },
      "ENTITY_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": true,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID сущности"
      },
      "REQUISITE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к реквизитам"
      },
      "BANK_DETAIL_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к банковским реквизитам"
      },
      "MC_REQUISITE_ID": {
        "type": "integer",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Привязка к реквизитам моей компании"
      },
      "MC_BANK_DETAIL_ID": {
        "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 — Ошибки.

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