POST /api/v1/archive/de/{clientId} – RetailForce

Областта ARCHIVE на Middleware API (swagger) се използва за предаване (и изтегляне) на данни към RetailForce Secure Archive без използване на фискализация.

Използването на функциите/крайните точки в тази област е необходимо само ако фискализацията е деактивирана чрез RetailForce Middleware, т.е. НЕ се използва.

За архивиране на данни в рамките на фискализацията е необходима само съответната лицензия (присвояване чрез конфигурация). Качването на фискални данни в Cloud архива след това се извършва автоматично от фискалния middleware.

За

POST /api/v1/archive/de/{clientId}

се използва за прехвърляне на данни към RetailForce Cloud архива.

Резултат

Успешното извикване на крайната точка (200) предава съответните данни към Secure Archive.

Начин на използване

Всеки път, когато данните трябва да бъдат прехвърлени към архива за архивиране.

Предпоставки

Инсталиран е RetailForce Middleware (Fiscal) и
клиентът е инициализиран,

Заявка

Полета във формуляра

Трябва да бъдат подадени следните параметри:

Означение	Описание	Пример
clientId	Уникалният идентификатор (uniqueClientId) на касовия апарат (от RetailForce system).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Request body

Данните, които трябва да бъдат предадени към архива, трябва да бъдат посочени съответно. Това се извършва чрез payload-то, описано по-долу в заявката.

Пример:

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Информация в колоната „Type“:

M ... задължително / изисквано
M* ... задължително / изисквано в определени държави или при определени условия
R ... препоръчително
O... по избор

Елементи	Тип	Описание
тип	М	Определение на типа на данните, които ще бъдат прехвърлени в архива. Типове: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Данни от архивиране (разнообразни) Забележка: Размерите на файловете са ограничени, както следва: Тип 0: 200 kB Тип 1: 200 kB Тип 2: 10 MB
контейнер	M*	Името (означението) на контейнера (файл .zip) Забележка: САМО ако Тип = 2 („type”: 2,)
единица	M*	Данни, които трябва да бъдат прехвърлени в архива (файл или папка!).
рекурсивно	M*	true, ако трябва да се прехвърлят и подпапки, в противен случай false. Не се прилага, ако обектът НЕ е папка! Забележка: САМО ако Тип = 2 („type“: 2,)

Отговор

Възможни отговори:

Код	Описание	Пример
200	Данните бяха успешно предадени	-

Тази статия е преведена автоматично.