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

Ставки НДС каталога

Справочник ставок НДС торгового каталога: названия, проценты, активность и порядок сортировки. Идентификатор ставки передаётся в поле vatId товара.

Битрикс24 API: catalog.vat.* Скоуп: catalog

Создать ставку НДС

POST /v1/catalog-vat-rates

Добавляет ставку НДС в справочник торгового каталога. Тело запроса плоское, без обёртки fields.

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

Поле Тип Обяз. Описание
name string да Название ставки НДС.
rate number да Процент НДС, допускается дробное число и 0. null не принимается.
active string нет Активность: Y или N. Другие значения и null отклоняются.
sort number нет Порядок сортировки, целое число не меньше 1. null не принимается.

id и timestampX доступны только для чтения. Полный список — Поля ставки НДС.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-vat-rates" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs VAT 2026-10-08",
  "rate": 7.5,
  "active": "N",
  "sort": 900
}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-vat-rates" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs VAT 2026-10-08",
  "rate": 7.5,
  "active": "N",
  "sort": 900
}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-vat-rates', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Docs VAT 2026-10-08",
    "rate": 7.5,
    "active": "N",
    "sort": 900
  }),
})

const { success, data } = await res.json()
console.log('ID:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-vat-rates', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Docs VAT 2026-10-08",
    "rate": 7.5,
    "active": "N",
    "sort": 900
  }),
})

const { success, data } = await res.json()
console.log('ID:', data.id)

Поля ответа

Ответ приходит со статусом 201 и содержит созданную запись целиком.

Поле Тип Описание
success boolean Всегда true при успехе.
data object Объект ставки НДС.
data.id number Идентификатор ставки. Список: GET /v1/catalog-vat-rates. Его передают в поле vatId товара.
data.name string Название ставки.
data.rate number | null Процент НДС. У существующей ставки «Без НДС» может быть null.
data.active string Активность ставки: Y — активна, N — неактивна.
data.sort number Порядок сортировки.
data.timestampX string Дата и время изменения в формате ISO 8601. Заполняется Битрикс24.
meta.warnings array При неизвестном имени поля содержит предупреждение UNRECOGNIZED_WRITE_FIELD с ключами code, field, message. Объект fields на маршруте, который сам оборачивает карту полей и где схема не объявляет fields, отклоняется с 400 NESTED_FIELDS_ENVELOPE; передавайте поля плоско в корне JSON.

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

JSON 
{
  "success": true,
  "data": {
    "active": "N",
    "id": 25,
    "name": "Docs VAT 2026-10-08",
    "rate": 7.5,
    "sort": 900,
    "timestampX": "2026-10-08T18:49:59.000Z"
  }
}

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

400 — не передан rate, запись не создана:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "Body field \"rate\" is required to create catalogVatRate."
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FIELDS Не передан name или rate, либо значение равно null или пустой строке. Сообщение называет первое отсутствующее поле.
400 INVALID_PARAMS Неверный тип поля, active вне Y/N, дробный или неположительный sort. В active и sort нельзя передавать null.
400 READONLY_FIELD В теле передан id или timestampX. Уберите поле из запроса.
422 BITRIX_ERROR Битрикс24 отклонил запрос. Причина — в error.message, исходный код — в error.b24Code.
403 WRITE_BLOCKED_READONLY_KEY Запись запрещена: ключ работает в режиме только для чтения.
403 SCOPE_DENIED У ключа нет скоупа catalog.
401 MISSING_API_KEY Не передан заголовок X-Api-Key.
401 TOKEN_MISSING У ключа нет настроенных токенов Битрикс24. Для ключа OAuth-приложения проверьте пользовательскую сессию.

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

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

Неизвестное скалярное имя может не сохраниться. Оно не заменяет проверку обязательных полей. Ответ может содержать meta.warnings с кодом UNRECOGNIZED_WRITE_FIELD. Сверяйте имена с полями ставки НДС и проверяйте значения в data.

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