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

Поля типа плательщика

GET /v1/person-types/fields

Описывает поля типа плательщика для создания, изменения, выборки и фильтрации, а также доступные поля группировки.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/person-types/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/person-types/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data } = await res.json()
console.log('Поля типа плательщика:', Object.keys(data.fields))

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.fields object Описание полей. Ключ — имя поля, значение — его свойства
data.fields.<поле>.type string Тип значения: number, string или boolean
data.fields.<поле>.readonly boolean true — поле только для чтения
data.fields.<поле>.required boolean Приходит со значением true у name, обязательного при создании
data.fields.<поле>.nullable boolean Приходит со значением true у code и xmlId, допускающих null
data.fields.<поле>.notReturned boolean Приходит со значением true у lid: поле описано в схеме, но отсутствует в объектах ответа
data.fields.<поле>.label string Название поля
data.fields.<поле>.description string Описание поля
data.aggregatable array Поля для groupBy в агрегации типов плательщиков: active, code
data.batch array Операции пакетной записи: create, update, delete

Поля типа плательщика

Полный набор полей из схемы. Колонка RO — поле только для чтения.

Поле Тип RO Описание
id number да ID типа плательщика. Список: GET /v1/person-types
name string нет Название. Обязательно при создании и изменении
code string | null нет Уникальный код. null, если не задан
sort number нет Порядок сортировки
active boolean нет Активность типа
xmlId string | null нет Внешний идентификатор. null, если не задан
lid string да Сайт, назначенный Битрикс24. Помечен notReturned, отсутствует в объектах ответа

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "ID."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Название",
        "description": "Название."
      },
      "code": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Уникальный код",
        "description": "Уникальный код."
      },
      "sort": {
        "type": "number",
        "readonly": false,
        "label": "Порядок сортировки",
        "description": "Порядок сортировки."
      },
      "active": {
        "type": "boolean",
        "readonly": false,
        "label": "Активен",
        "description": "Активен."
      },
      "xmlId": {
        "type": "string",
        "readonly": false,
        "nullable": true,
        "label": "Внешний идентификатор",
        "description": "Внешний идентификатор."
      },
      "lid": {
        "type": "string",
        "readonly": true,
        "notReturned": true,
        "label": "Сайт, назначенный Битрикс24",
        "description": "Сайт, назначенный Битрикс24."
      }
    },
    "aggregatable": [
      "active",
      "code"
    ],
    "batch": [
      "create",
      "update",
      "delete"
    ]
  }
}

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

401 — не передан API-ключ:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа sale
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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