crm.vat.list
Получить список ставок НДС по фильтру
Описание
Метод crm.vat.list возвращает список ставок НДС по фильтру.
Является реализацией списочного метода для ставок НДС.
Параметры
order
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
field_n— название поля, по которому будет произведена сортировка выборки ставокvalue_n— значение типаstring, равное:
-ASC— сортировка по возрастанию
-DESC— сортировка по убыванию
Список доступных полей для сортировки можно узнать с помощью метода crm.vat.fields
filter
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
field_n— название поля, по которому будет отфильтрована выборка элементовvalue_n— значение фильтра
Список доступных полей для фильтрации можно узнать с помощью метода crm.vat.fields
select
array
необязательный
Массив возвращаемых полей. Если не указан, возвращаются все поля
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"ASC"},"filter":{"ACTIVE":"Y"},"select":["ID","NAME","RATE"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.vat.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"ASC"},"filter":{"ACTIVE":"Y"},"select":["ID","NAME","RATE"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.vat.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'crm.vat.list',
{
order: { ID: "ASC" },
filter: { ACTIVE: "Y" },
select: ["ID", "NAME", "RATE"]
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('crm.vat.list', { order: { ID: "ASC" }, filter: { ACTIVE: "Y" }, select: ["ID", "NAME", "RATE"] }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('crm.vat.list', { order: { ID: "ASC" }, filter: { ACTIVE: "Y" }, select: ["ID", "NAME", "RATE"] }, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'crm.vat.list',
[
'order' => ['ID' => 'ASC'],
'filter' => ['ACTIVE' => 'Y'],
'select' => ['ID', 'NAME', 'RATE'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching VAT list: ' . $e->getMessage();
}
BX24.callMethod(
"crm.vat.list",
{
order: { ID: "ASC" },
filter: { ACTIVE: "Y" },
select: ["ID", "NAME", "RATE"]
},
function(result) {
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.vat.list',
[
'order' => [ 'ID' => 'ASC' ],
'filter' => [ 'ACTIVE' => 'Y' ],
'select' => [ 'ID', 'NAME', 'RATE' ]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.vat.list", b24.Params{
"order": b24.Params{
"ID": "ASC",
},
"filter": b24.Params{
"ACTIVE": "Y",
},
"select": []string{"ID", "NAME", "RATE"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.vat.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ID": "1",
"NAME": "Без НДС",
"RATE": null
},
{
"ID": "3",
"NAME": "НДС 20%",
"RATE": "20.00"
},
{
"ID": "7",
"NAME": "12",
"RATE": "12.00"
}
],
"total": 3,
"time": {
"start": 1752044697.589623,
"finish": 1752044697.66439,
"duration": 0.0747671127319336,
"processing": 0.00588679313659668,
"date_start": "2025-07-09T10:04:57+03:00",
"date_finish": "2025-07-09T10:04:57+03:00",
"operating_reset_at": 1752045297,
"operating": 0
}
}
Возвращаемые данные
result
object
Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях ставок НДС.
Структура полей может быть изменена из-за параметра select
total
integer
Общее количество найденных элементов
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "Inadmissible fields for selection",
"error_description": "Переданы недопустимые поля для выборки."
}
| Код | Описание | Значение |
|---|---|---|
400 |
The Commercial Catalog module is not installed. |
Модуль catalog не установлен |
400 |
Access denied. |
Нет прав на выполнение операции |
400 |
"Inadmissible fields for selection. |
Переданы недопустимые поля для выборки |

