Для AI-агентов: markdown этой страницы — /docs-content/entities/person-types/get.md индекс документации — /llms.txt

Получить тип плательщика

GET /v1/person-types/:id

Получает сведения о типе плательщика, выбранном для заказа или настройки свойств заказа.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID типа плательщика. Список: GET /v1/person-types
select (query) string нет Поля через запятую, например ?select=id,name,active. Список полей: GET /v1/person-types/fields. В data останутся только выбранные поля

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/person-types/21" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/person-types/21" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types/21', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types/21', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Тип плательщика
data.id number ID типа плательщика, RO. Список: GET /v1/person-types
data.name string Название
data.code string | null Уникальный код
data.sort number Порядок сортировки
data.active boolean Активен ли тип
data.xmlId string | null Внешний идентификатор
meta.warnings array Предупреждения о неизвестных именах в select, с полями code, message, field. Приходит, только если предупреждения есть

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

JSON 
{
  "success": true,
  "data": {
    "active": false,
    "code": "DOCS_PERSON_397F55D8FB1D",
    "id": 21,
    "name": "Documentation payer type",
    "sort": 900,
    "xmlId": "DOCS_PERSON_397F55D8FB1D"
  }
}

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

404 — тип плательщика не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "person type is not exists"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является целым неотрицательным числом
404 ENTITY_NOT_FOUND Типа с таким id нет. Текст ошибки — person type is not exists
404 ENTITY_NOT_FOUND Запрос выполнился, но объекта в ответе нет. Текст ошибки — personType <id> not found
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Нет настроенных токенов доступа к Битрикс24

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

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