Try it — GetChecks

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

GetReferenceData: GetChecks – получить данные ЧекККМ/ЧекККМВозврат

  • Создано 10.07.2026
  • Обновлено 11.07.2026
  • Endpoint: GetReferenceData
  • Soap-method: GetChecks
Описание

Функция позволяет получить данные документа «Чек ККМ» и «Чек ККМ Возврат» для документа Накладная/Возвратная накладная.

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

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

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

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

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

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

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

<car:List>
   <car:Key>Reference</car:Key>
   <car:Value>getchecks</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

Параметр Тип Обязательно Описание
Reference string Имя справочника, должно быть равно «getchecks»
DocumentNumber string Номер документе в системе Карго для Прямой или Возвратной накладной
Возвращаемые параметры

Параметр Element в ответе содержит информацию об операциях (продажах или возврате) с набором стандартных реквизитов.

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

Key: строка со значением ListOfChecks;

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

Каждый элемент из списка List  содержит в себе:

  • Key: имя следующего элемента, для данной группы всегда CheckNumber (указывает, что далее следует идентификатор чека);
  • Value: номер чека, может быть пустым, если чек не был зафиксирован (например, при незавершенной операции);
  • ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
  • Properties: массив данных о товаре;
  • Fields: массив дополнительных параметров чека.

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

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


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

Параметр Тип Обязательно Описание
ClientNumber string Клиентский номер документа (если есть)
CheckNumber string Номер чека в смене
CheckType string Чек ККМ = "Sale"
Чек ККМ Возврат = "Return"
CheckDate data Дата документа
CheckNumberShift string Номер смены
FN string ФН - Номер фискального накопителя
FPD string ФПД - Фискальный признак документа
FD string ФД - Идентификатор фискальной записи
Total float Сумма документа
Properties Element Содержит список товаров из документа Чек
ККМ/ Чек ККМ Возврат
Возвращаемые параметры Properties

Блок Properties содержит информацию о товаре и может повторяться для каждой позиции в чеке.

Параметр Тип Обязательно Описание
Product string Наименование товара
Qty float Количество товара
Price float Цена товара
Cost float Итого сумма по строке
Примеры запроса/ответа
<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>getcheck</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>documentnumber</car:Key>
          <car:Value></car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>