Получить список ставок НДС по фильтру catalog.vat.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров» или «Управление ставками НДС»
Метод catalog.vat.list возвращает список ставок НДС с фильтрацией, сортировкой и постраничной навигацией.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив полей ставки НДС, которые нужно вернуть. Доступные поля: Если массив не передан или пустой, метод вернет все поля. Неизвестные поля метод пропускает без ошибки |
|
filter |
Объект для фильтрации выбранных ставок НДС в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Неизвестные поля в фильтре метод пропускает без ошибки и возвращает ставки без учета такого условия. Проверяйте имена полей по списку выше |
|
order |
Объект для сортировки выбранных ставок НДС в формате Возможные значения для Возможные значения для
Если |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","rate"],"filter":{"active":"Y"},"order":{"id":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.vat.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","rate"],"filter":{"active":"Y"},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.vat.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CatalogVatListResult = {
vats: {
id: number
name: string
rate: number | null
}[]
}
// catalog.vat.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
try {
const response = await $b24.actions.v2.call.make<CatalogVatListResult>({
method: 'catalog.vat.list',
params: {
select: [
'id',
'name',
'rate',
],
filter: {
active: 'Y',
},
order: {
id: 'ASC',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('VAT rates:', result.vats, 'count:', result.vats.length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchVatList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.vat.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'catalog.vat.list',
params: {
select: [
'id',
'name',
'rate',
],
filter: {
active: 'Y',
},
order: {
id: 'ASC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('VAT rates:', result.vats, 'count:', result.vats.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchVatList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.vat.list(
select=[
"id",
"name",
"rate",
],
filter={
"active": "Y",
},
order={
"id": "ASC",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.vat.list',
[
'select' => [
'id',
'name',
'rate'
],
'filter' => [
'active' => 'Y'
],
'order' => [
'id' => "ASC"
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result['vats'], true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing VAT: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.vat.list',
{
select: [
'id',
'name',
'rate'
],
filter: {
active: 'Y'
},
order: {
'id': "ASC"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.log(result.data());
if(result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.vat.list',
[
'select' => [
'id',
'name',
'rate'
],
'filter' => [
'active' => 'Y'
],
'order' => [
'id' => 'ASC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.vat.list", b24.Params{
"select": []string{"id", "name", "rate"},
"filter": b24.Params{
"active": "Y",
},
"order": b24.Params{
"id": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.vat.list: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"result": {
"vats": [
{
"id": 1,
"name": "Без НДС",
"rate": null
},
{
"id": 3,
"name": "НДС 22%",
"rate": 22
},
{
"id": 7,
"name": "НДС 12%",
"rate": 12
}
]
},
"total": 3,
"time": {
"start": 1793118107,
"finish": 1793118107.896136,
"duration": 0.8961360454559326,
"processing": 0,
"date_start": "2026-10-27T19:21:47+03:00",
"date_finish": "2026-10-27T19:21:47+03:00",
"operating_reset_at": 1793118660,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
result.vats |
Массив ставок НДС текущей страницы, не больше 50 элементов. Каждый элемент содержит поля из |
|
total |
Общее количество ставок, подходящих под фильтр. Если |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "200040300010",
"error_description": "Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access Denied |
У пользователя нет ни права «Просмотр каталога товаров», ни права «Управление ставками НДС» |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |