Получить список ставок НДС по фильтру crm.vat.list
Scope:
crmКто может выполнять метод: любой пользователь
DEPRECATED
Развитие метода остановлено. Используйте catalog.vat.list.
Метод crm.vat.list возвращает список ставок НДС по фильтру.
Является реализацией списочного метода для ставок НДС.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
order |
Объект формата:
Список доступных полей для сортировки можно узнать с помощью метода crm.vat.fields |
|
filter |
Объект формата:
Список доступных полей для фильтрации можно узнать с помощью метода crm.vat.fields |
|
select |
Массив возвращаемых полей. Если не указан, возвращаются все поля |
Примеры кода
Как использовать примеры в документации
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>';
Обработка ответа
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 |
Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях ставок НДС. Структура полей может быть изменена из-за параметра |
|
total |
Общее количество найденных элементов |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "Inadmissible fields for selection",
"error_description": "Переданы недопустимые поля для выборки."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Модуль catalog не установлен |
|
|
|
Нет прав на выполнение операции |
|
|
|
Переданы недопустимые поля для выборки |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить поля ставки НДС crm.vat.fields
- Получить ставку НДС по идентификатору crm.vat.get
- Создать ставку НДС crm.vat.add
- Обновить существующую ставку НДС crm.vat.update
- Удалить ставку НДС crm.vat.delete