Получить связь реквизитов

GET /v1/requisite-links/:entityTypeId/:entityId

Возвращает конкретную связь реквизитов по паре идентификаторов владельца.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да Тип владельца: 2 — сделка, 31 — счёт
entityId (path) number да ID владельца. Источник: GET /v1/deals или GET /v1/invoices

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-links/2/3773" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const entityTypeId = 2
const entityId = 3773

const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/requisite-links/${entityTypeId}/${entityId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)

const { success, data } = await res.json()
console.log('Реквизит:', data.REQUISITE_ID)

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

javascript 
const entityTypeId = 2
const entityId = 3773

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект связи
data.ENTITY_TYPE_ID number Тип владельца: 2 — сделка, 31 — счёт
data.ENTITY_ID number ID владельца
data.REQUISITE_ID string ID привязанного реквизита; "0" — не привязан. Источник: GET /v1/requisites
data.BANK_DETAIL_ID string ID привязанного банковского реквизита; "0" — не привязан. Источник: GET /v1/bank-details
data.MC_REQUISITE_ID string ID реквизита вашей компании; "0" — не привязан
data.MC_BANK_DETAIL_ID string ID банковского реквизита вашей компании; "0" — не привязан

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

JSON 
{
  "success": true,
  "data": {
    "ENTITY_TYPE_ID": 2,
    "ENTITY_ID": 3773,
    "REQUISITE_ID": "45",
    "BANK_DETAIL_ID": "0",
    "MC_REQUISITE_ID": "0",
    "MC_BANK_DETAIL_ID": "0"
  }
}

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

404 — связь не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "No requisite link for entityTypeId=2, entityId=999"
  }
}

Ошибки

HTTP Код Описание
404 NOT_FOUND Связь с указанным entityTypeId и entityId не найдена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан X-Api-Key

Полный список общих ошибок API — Ошибки.

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

У связи нет отдельного числового id. Она определяется парой значений владельца: entityTypeId и entityId — оба передаются в пути.

Смешанные типы в ответе. ENTITY_TYPE_ID и ENTITY_ID возвращаются числами, а остальные идентификаторы — REQUISITE_ID, BANK_DETAIL_ID, MC_REQUISITE_ID, MC_BANK_DETAIL_ID — строками.

Значение "0" означает отсутствие привязки. Для REQUISITE_ID, BANK_DETAIL_ID, MC_REQUISITE_ID, MC_BANK_DETAIL_ID строка "0" означает, что соответствующий реквизит не привязан, а не что привязан объект с ID 0.

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