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

Типы плательщиков

Справочник типов плательщиков интернет-магазина. Идентификатор типа передаётся в personTypeId заказа и свойства заказа.

Типы с кодами CRM_CONTACT и CRM_COMPANY защищены от удаления. При изменении любого типа передавайте name, даже если меняете только другие поля.

Битрикс24 API: sale.persontype.* Скоуп: sale

Создать тип плательщика

POST /v1/person-types

Создаёт тип плательщика в справочнике интернет-магазина для использования в заказах и их свойствах.

Поля передаются плоско в корне JSON, без обёртки fields.

Поля запроса (body)

Поле Тип Обяз. Описание
name string да Название типа плательщика
code string | null нет Уникальный код. Не должен совпадать с кодом другого типа
sort number нет Порядок сортировки
active boolean нет Активность типа
xmlId string | null нет Внешний идентификатор

Полный список полей — GET /v1/person-types/fields.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/person-types" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Documentation payer type",
  "code": "DOCS_PERSON_397F55D8FB1D",
  "xmlId": "DOCS_PERSON_397F55D8FB1D",
  "sort": 900,
  "active": false
}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/person-types" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Documentation payer type",
  "code": "DOCS_PERSON_397F55D8FB1D",
  "xmlId": "DOCS_PERSON_397F55D8FB1D",
  "sort": 900,
  "active": false
}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Documentation payer type',
    code: 'DOCS_PERSON_397F55D8FB1D',
    xmlId: 'DOCS_PERSON_397F55D8FB1D',
    sort: 900,
    active: false,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Documentation payer type',
    code: 'DOCS_PERSON_397F55D8FB1D',
    xmlId: 'DOCS_PERSON_397F55D8FB1D',
    sort: 900,
    active: false,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean true при успехе. HTTP-статус ответа — 201
data object Созданный тип плательщика
data.id number RO. ID типа плательщика
data.name string Название
data.code string | null Уникальный код
data.sort number Порядок сортировки
data.active boolean Активность типа
data.xmlId string | null Внешний идентификатор

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

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

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

422 — код уже занят другим типом плательщика:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "person type code exists",
    "b24Code": "200750000005"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FIELDS Не передано или пустое поле name
400 READONLY_FIELD Передано поле только для чтения: id или lid
400 INVALID_PARAMS В скалярное поле передан объект или массив, например объект в active
422 BITRIX_ERROR Код code уже занят. Текст — person type code exists, b24Code — 200750000005
422 BITRIX_ERROR Битрикс24 отклонил создание по другой причине. Текст причины — в message
403 BITRIX_ACCESS_DENIED У пользователя ключа нет прав на изменение типов плательщиков в Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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