Перейти к содержимому

GetReferenceData: VATRates — Ставки НДС

Функция позволяет получить список ставок НДС, использующиеся в других функциях при вызове web-сервиса. 

SOAP Endpoint: GetReferenceData Обновлено: 2026-05-19
  • Endpoint: GetReferenceData
  • SOAP-метод: VATRates
  • Группа: GetReferenceData
  • Создано: 16.04.2026 · Обновлено: 19.05.2026

Описание

Функция позволяет получить список ставок НДС, использующиеся в других функциях при вызове web-сервиса.

Параметры запроса

Параметр
Тип
Обязательно
Описание
login
string
да
логин
password
string
да
пароль
parameters
Element
да
список параметров

Описание параметра parameters

Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.

Он должен включать:

Key: строка со значением parameters (обязательное);

List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:

  • Key: имя параметра (например, Reference);
  • Value: значение параметра указывающая на то какой parameters описывается;
  • ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).

Пример одного элемента из List:

xml 
<car:List>
 <car:Key>Reference</car:Key>
 <car:Value>VATRates</car:Value>
 <car:ValueType>string</car:ValueType>
</car:List>

Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.

Иерархия структуры parameters:

parameters→ List (массив) → каждый элемент List→ Key, Value, ValueType.

Параметр
Тип
Обязательно
Описание
Reference
string
да
Имя справочника, должно быть равно «VATRates»

Возвращаемые параметры

Параметр Element в ответе содержит информацию о ставках НДС.

Он включает элементы справочника:

Key: идентификатор справочника, к которому относится запись (например, VATRates);

List: контейнер записи справочника, каждая запись соответствует одной ставке НДС.

Каждая запись справочника из списка List описывает одну ставку НДС в виде структуры Element и содержит в себе:

  • Key: числовой идентификатор ставки НДС (например, 2, 3,4 и т.д.);
  • Value: описание ставки НДС в формате "X%" или "X% / Y%";
  • ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).

Структура ответа иерархична:

Element→ Key + List (массив) → каждый элемент List→ Key + Value +ValueType.

---

Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).

Параметр
Тип
Обязательно
Описание
Key
string
нет
Код ставки НДС
Value
string
нет
Описание ставки НДС

Пример запроса (XML Request)

xml 
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:car="http://www.cargo3.ru">
  <soap:Header/>
  <soap:Body>
    <car:GetReferenceData>
      <car:login>test</car:login>
      <car:password>2016</car:password>
      <car:parameters>
        <car:Key>parameters</car:Key>
        <car:List>
          <car:Key>Reference</car:Key>
          <car:Value>VATRates</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>

Пример ответа (XML Response)

xml 
<soap:Envelope
  xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
  <soap:Body>
    <m:GetReferenceDataResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <m:Key>VATRates</m:Key>
        <m:List>
          <m:Key>2</m:Key>
          <m:Value xsi:type="xs:string">10%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>3</m:Key>
          <m:Value xsi:type="xs:string">10% / 110%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>4</m:Key>
          <m:Value xsi:type="xs:string">0%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>5</m:Key>
          <m:Value xsi:type="xs:string">Без НДС</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>8</m:Key>
          <m:Value xsi:type="xs:string">12%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>9</m:Key>
          <m:Value xsi:type="xs:string">12% / 112%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>10</m:Key>
          <m:Value xsi:type="xs:string">5%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>11</m:Key>
          <m:Value xsi:type="xs:string">5% / 105%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>12</m:Key>
          <m:Value xsi:type="xs:string">7%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>13</m:Key>
          <m:Value xsi:type="xs:string">7% / 107%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>14</m:Key>
          <m:Value xsi:type="xs:string">16%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>15</m:Key>
          <m:Value xsi:type="xs:string">16% / 116%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>16</m:Key>
          <m:Value xsi:type="xs:string">22%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>17</m:Key>
          <m:Value xsi:type="xs:string">22% / 122%</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>

Смежные методы

AvailableDeliveryDates

Функция позволяет получить информацию о возможных датах доставки груза.

BaseUnitsOfMeasurement

Функция позволяет получить список базовых единиц измерения, использующиеся в других функциях при вызове web-сервиса.

CargoStates

Функция позволяет получить список доступных состояний грузов.