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

Middleware API (Swagger) skyrius „ARCHIVE“ naudojamas duomenims perduoti į „RetailForce Secure Archive“ (arba juos atsisiųsti) nenaudojant fiskalizacijos.

Šio skyriaus funkcijas / galinius taškus reikia naudoti tik tuo atveju, jei fiskalizacija per „RetailForce“ tarpinę programinę įrangą yra išjungta, t. y. NENAUDOJAMA.

Duomenų archyvavimui fiskalizacijos kontekste reikalinga tik atitinkama licencija (priskiriama per konfigūraciją).

Galinis taškas

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

naudojamas duomenims perduoti į „RetailForce“ debesų archyvą.

Rezultatas

Sėkmingai iškvietus galinį tašką (200), atitinkami duomenys buvo sėkmingai perduoti į saugų archyvą.

Naudojimas

Kiekvieną kartą, kai duomenys turi būti perduoti į archyvą saugojimui.

Reikalavimai

Įdiegta „RetailForce (Fiscal)“ tarpinė programinė įranga ir
inicijuotas klientas.

Užklausa

Formos laukeliai

Turi būti perduoti šie parametrai:

Pavadinimas	Aprašymas	Pavyzdžiai
clientId	Kaso aparato unikalus identifikatorius (iš „RetailForce“ sistemos)	c1062c55-57c4-4ed2-9c53-aff1762326a4

Užklausos tekstas

Duomenys, kurie turi būti perduoti į archyvą, turi būti atitinkamai nurodyti. Tai atliekama naudojant toliau aprašytą užklausos duomenų bloką.

Pavyzdys:

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

Informacija stulpelyje „Tipas“:

M ... privaloma („mandatory“)
M* ... privaloma tam tikromis sąlygomis
R ... rekomenduojama („recommended“)
O ... neprivaloma

Elementas	Tipas	Aprašymas
type	M	Duomenų tipo, kuris turi būti perduotas į archyvą, apibrėžimas. Tipai: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Atsarginės kopijos duomenys (TAR duomenys, kiti) Pastaba: Failų dydžiai ribojami taip: 0 tipas: 200 kB 1 tipas: 200 kB 2 tipas: 10 MB
konteineris	M*	Konteinerio (.zip failo) pavadinimas (aprašymas) Pastaba: TIK jei Type = 2 („type“: 2,)
entity	M*	Duomenys, kurie turi būti perduoti į archyvą (failas arba aplankas!).
recursive	M	true (taip), jei turi būti perduoti ir pakatalogiai, kitais atvejais – false (ne). Netaikoma, jei entitetas NĖRA aplankas! Pastaba: TIK kai Type = 2 („type“: 2,)

Atsakymas

Galimi atsakymai:

Kodas	Aprašymas	Pavyzdys
200	Duomenys sėkmingai perduoti	-