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

Список ставок НДС

GET /v1/catalog-vat-rates

Возвращает ставки НДС торгового каталога с фильтрацией и сортировкой.

Параметры

Параметр Тип По умолч. Описание
limit (query) number 50 Количество записей, от 1 до 5000. Нечисловое значение заменяется на 50.
offset (query) number 0 Пропустить N записей. ?offset=1 начинает выдачу со второй записи, кратность 50 не нужна.
select (query) string — Выборка полей через запятую: ?select=id,name,rate. Имена — из полей ставки НДС.
sort (query) string id Сортировка: ?sort=-rate, минус означает убывание. Несколько полей — через запятую: ?sort=sort,id.
order (query) object — Сортировка объектом: ?order[rate]=desc. Если передан sort, применяется он.
filter (query) object — Фильтрация по полям GET /v1/catalog-vat-rates/fields.
Синтаксис фильтрации. Пример: ?filter[active]=Y.
withTotal (query) string — Запросить количество записей: true или false. Для этого справочника false не отключает meta.total. Листание и количество записей.

Примеры

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/catalog-vat-rates?filter[id]=25&limit=1&withTotal=true" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -g "https://vibecode.bitrix24.tech/v1/catalog-vat-rates?filter[id]=25&limit=1&withTotal=true" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-vat-rates?filter[id]=25&limit=1&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-vat-rates?filter[id]=25&limit=1&withTotal=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе.
data array Массив ставок НДС.
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.total number Количество ставок под фильтром. Приходит в том числе при withTotal=false.
meta.hasMore boolean Есть ли ещё ставки за пределами limit.
meta.warnings array Появляется при предупреждениях: UNKNOWN_SELECT_FIELD — неизвестное имя в select, LIMIT_ZERO_IGNORED — limit равен 0, применяется значение по умолчанию.

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

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"
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

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

400 — фильтр по полю nope, которого нет в схеме:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nope' for entity 'catalog-vat-rates'. Available: id, name, rate, active, sort, timestampX"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю вне схемы. Сообщение перечисляет доступные поля.
400 UNKNOWN_SORT_FIELD Сортировка по полю вне схемы.
400 INVALID_FILTER filter не JSON-объект либо смешаны filter[поле]=… и filter={...}. Используйте одну форму.
400 INVALID_FILTER_OPERATOR Неизвестный оператор или логический ключ $or, $and, $not. Для нескольких значений одного поля используйте $in.
403 SCOPE_DENIED У ключа нет скоупа catalog.
401 MISSING_API_KEY Не передан заголовок X-Api-Key.
401 TOKEN_MISSING У ключа нет настроенных токенов Битрикс24. Для ключа OAuth-приложения проверьте пользовательскую сессию.

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

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

Неизвестное имя в select не останавливает запрос. Ответ приходит с 200, в записях остаются доступные поля, а meta.warnings содержит UNKNOWN_SELECT_FIELD. Проверяйте предупреждения, чтобы заметить опечатку.

Ставка «Без НДС» может иметь rate: null. Такое значение отличается от числовой ставки 0, учитывайте его при отображении и расчётах.

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