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

Обновить ставку НДС

PATCH /v1/catalog-vat-rates/:id

Частично обновляет ставку НДС торгового каталога. Передайте только изменяемые поля в плоском теле, без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор ставки, целое неотрицательное число. Список: GET /v1/catalog-vat-rates.

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

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

Примеры

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-vat-rates/25" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs VAT updated 2026-10-08"
}'

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-vat-rates/25" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Docs VAT updated 2026-10-08"
}'

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

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

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

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

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

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

Поля ответа

При успехе возвращается 200 и обновлённая запись целиком.

Поле Тип Описание
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 updated 2026-10-08",
    "rate": 7.5,
    "sort": 900,
    "timestampX": "2026-10-08T18:50:04.000Z"
  }
}

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

422 — в rate передан null, ставка не изменена:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Required fields: rate",
    "b24Code": "0"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Ставки с таким id нет, в том числе после удаления.
400 INVALID_PARAMS id не является целым неотрицательным числом, например abc.
400 EMPTY_UPDATE_BODY Тело пустое или не является JSON-объектом. Передайте хотя бы одно поле.
400 INVALID_PARAMS Неверный тип поля, active вне Y/N, дробный или неположительный sort. В active и sort нельзя передавать null.
400 READONLY_FIELD В теле передан id или timestampX. Уберите поле из запроса.
422 BITRIX_ERROR rate: null отклоняется с сообщением Required fields: rate. Другие отказы Битрикс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 — Ошибки.

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

Для одиночного PATCH не нужно повторять name и rate. Если поле пропущено, Вайбкод подставляет текущее значение ставки перед обновлением. Явно переданный null таким значением не заменяется. Если у существующей ставки rate равен null, передайте числовой rate, иначе Битрикс24 может отклонить изменение другого поля.

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

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