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

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

Параметр 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 (массив) → каждый элемент List→ Key, Value, ValueType.

Параметр 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 — Коды ошибок). 

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