„RetailForce“ fiskalinės paslaugos – API aprašymas – RetailForce

Šiame straipsnyje pateikiama „RetailForce“ fiskalinės paslaugos API funkcijų apžvalga (versija 1.6.3). Reikiamus kiekvieno galinio taško parametrus galima peržiūrėti po fiskalinės tarpinės programinės įrangos įdiegimo per „Swagger“ (pvz., http://localhost:7678/swagger/index.html).

API yra suskirstyta į skirtingas sritis, kurios naudojamos įvairiems tikslams ir produktams.

Informacija stulpelyje „Tipas“:

O ... neprivaloma
M ... privaloma / būtina
M* ... privaloma / būtina tam tikrose šalyse arba tam tikromis sąlygomis
R ... rekomenduojama

Antraštės atitinka atitinkamus skyrius Swagger. Prie kai kurių galinių taškų rasite nuorodas į išsamesnę informaciją.

Archyvai

Trumpas aprašymas: jau fiskalizuotų duomenų archyvavimas.

Šio skirsnio galiniai taškai naudojami jau fiskalizuotų duomenų perdavimui į „Secure RetailForce“ archyvą.

Atkreipkite dėmesį: šis skyrius NĖRA būtinas, jei naudojate fiskalizavimo tarpinę programinę įrangą! Fiskalinių duomenų archyvavimas vyksta automatiškai ir priklauso nuo pasirinktos licencijos.

Galinis taškas	Tipas	Aprašymas
POST /api/v1/archive/de/{clientId}	O	Šis metodas naudojamas įvairiems failams perkelti į debesų archyvą.
GET /api/v1/archive/de/{clientId}	O	Skirta anksčiau archyvuotų duomenų (failų) atsisiuntimui iš debesų archyvo

Atsarginė kopija

Trumpas aprašymas: Archyvavimo funkcija bet kokiems kasos duomenims.

Šio skirsnio galiniai taškai skirti bet kokiems duomenims įkelti į debesų archyvą – paslaugai/produktui: „POS archyvas“. Norint naudotis šia paslauga, reikalinga atsarginės kopijos licencija.

Galinis taškas	Tipas	Aprašymas
POST /api/v1/backup/{clientId}	O	Šiuo metodu atsarginė kopija išsaugoma tam tikrame debesų archyvo aplanke.
POST /api/v1/backup/{clientId}/restore	O	Atkuria anksčiau archyvuotą failą (atsarginę kopiją) tam tikroje vietoje.
GET /api/v1/backup/{clientId}/restore	O	Grąžina atsisiuntimo URL adresą, kuriuo galima atsisiųsti prašomą atsarginės kopijos failą iš debesų archyvo.

Uždarymas

Trumpas aprašymas: kasos dienos uždarymo funkcijos

Šiame skyriuje pateikiamos įvairios kasos apskaitos funkcijos. Daugiau informacijos apie kasos dienos uždarymo įrašus rasite straipsnyje: Kasos dienos uždarymas

Galutinis taškas	Tipas	Aprašymas
POST /api/v1/closing/{clientId}/book/ openingStock	O	Įrašo pradinį likutį kasos uždarymui. Įrašo tik įmoką, nenustato naujo kasos likučio. Alternatyva: Alternatyviai kasos aparatas taip pat gali įrašyti dokumentą: documentType [11] = PayIn.
PUT /api/v1/closing/{clientId}/book/ cashDifference	O	Persiunčia kasos skirtumo įrašą į tarpinę programinę įrangą. Alternatyva: Kaip alternatyvą, kasos aparatas taip pat gali įrašyti kvitą su BusinessTransactionType [91] = CashDifference.
PUT /api/v1/closing/{clientId}/book/ cashLift	O	Įrašo pinigų pervedimą (money transfer) iš kasos sistemos į banką (ar kitą paskirties vietą).
GET /api/v1/closing/{clientId}/ actualStock	O	Grąžina dabartinį pinigų likutį. Jis apskaičiuojamas remiantis perduotais dokumentais (be pardavimo ir grąžinimo kvitų taip pat įmokos ir išmokos ir pan.).
POST /api/v1/closing/{clientId}/ cashpointCheck	O	Patikrina faktinį šios kasos pinigų likutį ir grąžina sąrašą pinigų, kurių yra skirtumas (arba tuščią sąrašą, jei skirtumo nėra).
POST /api/v1/closing/{clientId}/ cashpointClose	O	Uždaro einamąją dieną su dienos uždarymo ataskaita.
GET /api/v1/closing/{clientId}/ endofdayDocument	O	Grąžina dienos uždarymo dokumentą už einamąją dieną. Grąžintas dokumentas turi būti išsaugotas (storeDocument > documentType: 99).
GET /api/v1/closing/{clientId}/ lastClosing	O	Grąžina konkretaus kliento (kliento/terminalo) paskutinio uždarymo datą ir laiką.
GET /api/v1/closing/{clientId}/ closingNecessary	O	Pateikia informaciją, ar tam tikram terminalui reikia atlikti dienos uždarymą, ar ne. (Priklauso nuo RetailForce.Fiscalisation.Implementation. IFiscalCountryProperties. MaximumHourIntervalForClosing.)

Informacija

Trumpas aprašymas: specialios informacijos užklausai

Galutinis taškas	Tipas	Aprašymas
GET /api/v1/information/version	O	Grąžina dabartinę fiskalinės tarpinės programinės įrangos (SW) versiją.
GET /api/v1/information/version/{clientId}	O	Grąžina nurodyto kliento šalies modulio versiją.
GET /api/v1/information/countryProperties	O	Grąžina fiscalCountryProperties užklausos šalies.
GET /api/v1/information/client/{clientId}/ countryProperties	O	Grąžina fiscalCountryProperties tam tikram klientui.
GET /api/v1/information/client/{clientId}/ uniqueCashRegisterId	O	Grąžina unikalų kasos numerį (filialo numeris/kasos numeris).
GET /api/v1/information/client/{clientId}/ status	O	Grąžina prašomo fiskalinio kliento būseną.
GET /api/v1/information/client/{clientId}/ accessLicenses	O	Grąžina prašomo kliento licencijų sąrašą.
GET /api/v1/information/client/{clientId}/ licenses	O	Grąžina prašomo kliento teisę į licenciją.
GET /api/v1/information/client/{clientId}/ getVatIdentification	R	Grąžina atitinkamą PVM identifikatorių, susijusį su prašomu procentiniu dydžiu.
GET /api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName}	O	Grąžina privalomus laukelius, nurodytus typeName tipui, nurodytam šalies įgyvendinimui.
POST /api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk	R	Jei ši parinktis nustatyta kaip „true“, kiekvienas klaidų dokumentas bus išsaugotas fiskalinio kliento kataloge.
GET /api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk	R	Grąžina, ar parinktis „RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk“ yra įjungta.
GET /api/v1/information/performance/ {clientId}	O	Grąžina visus nurodyto kliento našumo rodiklių identifikatorius (performance counter IDs)
DELETE /api/v1/information/performance/ {clientId}	O	Atkuria visus vidutinius duomenis (veiklos rodiklius) nurodytam klientui.
GET /api/v1/information/performance {clientId}/{performanceCounterId}	O	Grąžina prašomo našumo rodiklio ID vidutinius duomenis.
DELETE /api/v1/information/performance/ {clientId}/{performanceCounterId}	O	Atkuria vidutinius duomenis nurodytam klientui ir nurodytam našumo rodikliui.
PUT /api/v1/information/performance/ {clientId}/file	O	Įjungia arba išjungia našumo duomenų registravimą. Našumo duomenų registravimas pagal numatytuosius nustatymus yra išjungtas.
GET /api/v1/information/progress/ {clientId}	O	Grąžina visą pažangos informaciją (progress information label) nurodytam klientui.
GET /api/v1/information/progress/{clientId}/ {label}	O	Grąžina visą pažangos informaciją (progress information) apie nurodytą klientą ir atitinkamą etiketę (pavadinimą).

Valdymas

Trumpas aprašymas: valdymo funkcijos, paleidimas ir išjungimas ir kt.

Galutinis taškas	Tipas	Aprašymas
PUT /api/v1/management/clients	O/M	Sukuria naują klientą konfigūracijos saugykloje. Konfigūracijos objektą turi paruošti POS sistema. Kliento konfigūracija yra būtina sistemos veikimui. Naudokite šį galinį tašką arba: PUT /api/v1/management/clients, arba PUT /api/v1/management/clients/ byCloud/id.
POST /api/v1/management/clients	O	Atnaujina kasos sistemos sukurtą kliento konfigūraciją konfigūracijų saugykloje.
GET /api/v1/management/clients	O	Grąžina visus konfigūracijos saugykloje esančius klientus. Taip pat gali būti naudojama naudojant debesų konfigūraciją.
PUT /api/v1/management/clients/ byCloud	O/M	Sukuria naują klientą su debesyje parengta konfigūracija / arba įkelia esamą klientą. Kliento konfigūracija bet kuriuo atveju yra būtina veikimui. Naudokite šį galinį tašką arba PUT /api/v1/management/clients, arba PUT /api/v1/management/clients/ byCloud/id.
PUT /api/v1/management/clients/ byCloud/id	O	Sukuria klientą su konfigūracijos duomenimis iš debesies (žr. aukščiau). Alternatyva: alternatyvus galinis taškas vietoj PUT /api/v1/management/clients ir PUT /api/v1/management/clients/byCloud.
PUT /api/v1/management/clients/ byCloud/{clientId}	R	Atnaujina kliento konfigūraciją, ją atsisiųsdamas iš debesies. Naudojama, kai debesyje parengta konfigūracija buvo atnaujinta ir turi būti iš naujo atsisiųsta iš fiskalinio kliento (atnaujinimas).
POST /api/v1/management/clients/ withCloud	O/M	Sukuria naują klientą (vietinį) ir prideda šį klientą prie debesies konfigūracijos. Klientas sukuriama vietinėje konfigūracijos saugykloje, o konfigūracijos objektas vėliau įkeliama į debesų sistemą. Pastaba: platintojas turi būti nurodytas kliento informacijoje, o platintojas turi turėti teisę kurti naujus klientus.
POST /api/v1/management/cloud/ connect	M*	Sukuria atitinkamo kliento ryšį su debesimi ir įkelia fiskalinį modulį į talpyklą. Būtina sistemoms, kurios naudoja debesies funkcijas. Būtina po kiekvieno POS sistemos perkrovimo.
POST /api/v1/management/cloud/ updateLicense	O	Atnaujina dabartinį licencijos raktą fiskalinio kliento konfigūracijoje (taip pat ir kietajame diske). Būtina, jei licencijos buvo pakeistos debesų konfigūracijoje.
HEAD /api/v1/management/cloud/queue	R	Metodas, skirtas paleisti arba sustabdyti debesies įkėlimą (eilę) visiems klientams. Komanda „stop“ sustabdo įkėlimą po dabartinio failo apdorojimo. „Start“ iškart pradeda eilės apdorojimą. Jei apdorojimas debesies eilėje sustabdomas, turite jį paleisti iš naujo, nebent paslauga būtų paleista iš naujo (tuomet debesies apdorojimas vėl įjungiamas).
GET /api/v1/management/clients/ {clientId}	O	Grąžina konkretaus kliento konfigūraciją.
DELETE /api/v1/management/clients/ {clientId}	O	Ištrina konkretų klientą . Įspėjimas: naudokite atsargiai!
GET /api/v1/management/clients/id	O	Grąžina unikalų kliento ID pagal nurodytus parametrus. Norint gauti uniqueClientId, galima naudoti įvairius parametrus.
GET /api/v1/management/clients/ licenseConsumerId	O	Grąžina licencijos vartotojo ID pagal nurodytus parametrus. Grąžinami tik tie licenseConsumerId, kurie jau yra išsaugoti konfigūracijos saugykloje.
GET /api/v1/management/clients/ validate	O	Patikrina nurodytą kliento informaciją, kad būtų įvykdyti reikalingi šalies specifiniai konfigūracijos reikalavimai. Naudojama kasos sistemos sukurtai konfigūracijai patvirtinti prieš naudojant /api/v1/management/clients. Debesų konfigūracijos patvirtinimas atliekamas debesų sistemoje (esant debesų konfigūracijai).
POST /api/v1/management/clients/ initialize	M	Inicijuoja fiskalinį įrenginį (ir galimą įrangą bei atlieka galimą pranešimą finansų institucijoms). Inicijavimas atliekamas naudojant pradžios dokumentą, kurį galima gauti per GET /api/v1/transactions/document/{clientId}/start galinį tašką arba kurį sukuria kasos sistema.
POST /api/v1/management/clients/ migrate/{clientId}	O	Perkelia klientą iš kito fiskalinės programinės įrangos teikėjo. Naudojama pereinant nuo kito fiskalinės programinės įrangos teikėjo prie „RetailForce“. Atkreipkite dėmesį į palaikomas sistemas.
POST /api/v1/management/clients/ migrate/{clientId}/file	O	Perkelia klientą iš kito fiskalinės programinės įrangos teikėjo ir atlieka failo importą. Atkreipkite dėmesį į palaikomas sistemas!
POST /api/v1/management/clients/ decommission	R	Kliento (ir galimos įrangos) išjungimas bei galimas išregistravimas iš mokesčių institucijų.
PUT /api/v1/management/clients/ {clientId}/supportPackage	R	Įkelia palaikymo paketą (žurnalo failus) nurodytam klientui į debesiją. Šis galinis taškas yra būtinas, norint naudotis funkcija „Upload support package“ debesų sistemoje
GET /api/v1/management/clients/ recovery/{clientId}/backup	R	Sukuria kliento atsarginę kopiją su nurodytu failo pavadinimu (ZIP failo atsarginė kopija). Jei naudojamas įkėlimas į debesį, debesies eilės apdorojimas sustabdomas ir paleidžiamas iš naujo (o debesies eilė iš naujo inicijuojama). Dėmesio! Atkreipkite dėmesį, kad debesų įkėlimas bus atnaujintas po atsarginės kopijos sukūrimo, jei klientas nebus pašalintas (ištrintas). Jei prieš atsarginę kopiją failai dar nebuvo įkelti į debesį, jie taip pat yra atsarginės kopijos dalis ir gali būti įkelti du kartus, jei klientas bus atkurtas.
POST /api/v1/management/clients/ recovery/restore	R	Atkuria klientą (su visais duomenimis) iš nurodyto atsarginės kopijos ZIP failo.
POST /api/v1/management/clients/ recovery/restoreByCloud	R	Sukuria naują klientą su konfigūracija iš debesies / arba įkelia esamą klientą.
POST /api/v1/management/clients/ recovery/restoreByCloud/id	O	Sukuria naują klientą su konfigūracija iš debesies / arba atkuria esamą klientą.
POST /api/v1/management/clients/ {clientId}/globalShortId	O	Sukuria naują arba grąžina jau esamą, visuotinai unikalų ID atitinkamam klientui. Be to, aktyvuojamas retailForceReceiptId išdavimas atitinkamam klientui.
POST /api/v1/management/clients/ {clientId}/certificate	O/M	Išsaugo išorinį sertifikatą fiskalinio modulio sertifikatų saugykloje. Būtina sistemoms, kurios NENAUDOJA „RetailForce Cloud“ funkcijų fiskalinėse šalyse, kuriose fiskalizacijos procese naudojami programinės įrangos sertifikatai (Slovėnija, Kroatija, Ispanija, ...)
GET /api/v1/management/clients/ {clientId}/licenses/accessLicense	O	Grąžina informaciją, ar prašomas klientas turi prašomą prieigos licenciją.
GET /api/v1/management/clients/ {clientId}/licenses/license	O	Grąžina, ar prašomas klientas turi prašomą licenciją.

ManagementController_Austria

Trumpas aprašymas: Austrijos fiskalizacijos valdymo funkcijos.

Galutinis taškas	Tipas	Aprašymas
POST /api/v1/management/austria/ {clientId}/aes	O	Sukuria AES vartotojo raktą šiam klientui ir jį grąžina. AES raktas taip pat išsaugomas kliento konfigūracijoje. Pastaba: AES vartotojo raktas automatiškai sukurtas fiskalinio kliento. Galinis taškas reikalingas tik tuo atveju, jei AES rakto sukūrimą reikia inicijuoti rankiniu būdu.
GET /api/v1/management/austria/ {clientId}/aes	O	Grąžina nurodyto kliento AES vartotojo raktą.
GET /api/v1/management/austria/ {clientId}/dep	O/M	Eksportuoja visas vietinio duomenų registravimo protokolo (DEP §7 RKSV) dokumento eilutes. Būtina neprisijungusioms sistemoms (sistemoms, kurios NENAUDOJA fiskalinių duomenų archyvavimo debesyje)
GET /api/v1/management/austria/ {clientId}/dep131	O	Eksportuoja visus DEP131 (DEP 搂131 BAO) protokolui reikalingus duomenis iš vietoje saugomų duomenų.
GET /api/v1/management/austria/ {clientId}/dep/startReceipt	R	Grąžina šio kliento pradinį kvitą. Kasinės sistemos turi būti pajėgios finansinių patikrinimų metu pateikti pradinį kvitą pagal užklausą. Jei kasinė sistema neprisaugojo pradinio kvito, jį galima užsisakyti per šį galinį tašką.
GET /api/v1/management/austria/ {clientId}/dep/monthReceipts	R	Grąžina visus mėnesio dokumentus už prašomą laikotarpį. Kasinės sistema turi būti pajėgi finansinės policijos patikrinimo metu pateikti mėnesinius dokumentus pagal užklausą. Jei kasinė sistema šių dokumentų neišsaugojo, juos galima užsisakyti per šį galinį tašką.
GET /api/v1/management/austria/ {clientId}/fon/certificate	O	Grąžina visus parašo kūrimo įrenginius ir informaciją, ar jie aktyvuoti „FinanzOnline“ (FON) sistemoje.
POST /api/v1/management/austria/ {clientId}/fon/certificate	O	Registruoja konfigūruotą arba su „certificateSerial“ identifikuotą parašo kūrimo įrenginį „FinanzOnline“. Pastaba: Jei naudojami „RetailForce Cloud Services“, sertifikatai automatiškai registruojami „FinanzOnline“ portale (FON) (reikalingi kasos žiniatinklio paslaugos vartotojo prisijungimo duomenys!); galinis taškas reikalingas tik tuo atveju, jei registracija turi būti atliekama rankiniu būdu.
DELETE /api/v1/management/austria/ {clientId}/fon/certificate	O	Praneša apie konfigūruoto arba pagal certificateSerial identifikuoto parašo kūrimo įrenginio išėmimą iš eksploatacijos „FinanzOnline“. Dėmesio: naudokite atsargiai!
GET /api/v1/management/austria/ {clientId}/fon/document	R	Patvirtina paskutinį pasirašytą dokumentą DEP (duomenų registravimo protokole) per „FinanzOnline“ (FON).
GET /api/v1/management/austria/ {clientId}/fon/document/{depDocument}	R	Patvirtina nurodytą dokumentą (QR kodą) per FON.
GET /api/v1/management/austria/ {clientId}/fon/cashregister	O	Grąžina informaciją, ar dabartinio kliento kasos aparatas yra užregistruotas FON sistemoje. Būtina neprisijungusioms sistemoms.
POST /api/v1/management/austria/ {clientId}/fon/cashregister	O	Registruoja dabartinio kliento kasos ID FON sistemoje. Būtina neprisijungusioms sistemoms.
DELETE /api/v1/management/austria/ {clientId}/fon/cashregister	O	Praneša apie dabartinio kliento kasos ID išjungimą FON sistemoje. Būtina neprisijungusioms sistemoms. Dėmesio: naudokite atsargiai!

ManagementController_Bulgaria

Trumpas aprašymas: valdymo funkcijos, skirtos Bulgarijos fiskalizacijai.

Galutinis taškas	Tipas	Aprašymas
POST /api/v1/management/bulgaria/ {clientId}/commands/closing	M	Siunčia dienos uždarymo komandą (Z) į fiskalinį spausdintuvą.
POST /api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime	M	Siunčia laiko sinchronizavimo komandą (L) į fiskalinį spausdintuvą.
GET /api/v1/management/bulgaria/ {clientId}/reports/klen	R	Naudojant šią funkciją galima sukurti vadinamąją KLEN ataskaitą. (nuo v1.8.3)
GET /api/v1/management/bulgaria/ {clientId}/reports/zreport	R	Naudojant šią funkciją spausdinami išsamūs ir apibendrinamosios laikotarpio ataskaitos. (nuo v.1.8.3)
GET /api/v1/management/bulgaria/ {clientId}/reports/block	R	Naudojant šią funkciją, išspausdinama vadinamoji BLOCK ataskaita. (nuo v1.8.3)

ManagementController_Denmark

Trumpas aprašymas: Danijos fiskalizacijos valdymo funkcijos.

Galutinis taškas	Tipas	Aprašymas
GET /api/v1/management/denmark/ {clientId}/saft	M	Eksportuoja Danijos SAF-T formatą į nurodytą srautą.

ManagementController_France

Trumpas aprašymas: Prancūzijos fiskalinės apskaitos valdymo funkcijos.

Galutinis taškas	Tipas	Aprašymas
GET /api/v1/management/france/ eventlog/{clientId}	M	Grąžina visus prašomus audito žurnalo įrašus pagal datą.
GET /api/v1/management/france/ archive/{clientId}	M	Grąžina vietoje saugomus archyvus, kuriuos reikia uždaryti.
POST /api/v1/management/france/ archive/{clientId}/verify	M	Metodas, skirtas Prancūzijos archyvui patikrinti

ManagementController_Germany

Trumpas aprašymas: Vokietijos fiskalizacijos valdymo funkcijos.

Galutinis taškas	Tipas	Aprašymas
GET /api/v1/management/germany/tse	R	Grąžina prijungtų vietinių TSE įrenginių masyvą ir jų būseną.
POST /api/v1/management/germany/tse/ {tseSerial}/selftest	R	Atlieka sinchroninį nurodytos kasos aparato savikontrolės testą TSE (kasos aparatas yra neprivalomas).
PUT /api/v1/management/germany/ {clientId}/tse/connectTest	R	Sukuria bandomąjį ryšį su nurodyta TSE.
GET /api/v1/management/germany/ {clientId}/tse/listClients	O	Grąžina visus klientus, įtrauktus į nurodyto kliento TSE.
GET /api/v1/management/germany/ {clientId}/tse/status	R	Grąžina TSE būseną. Jei fiskalinis modulis nerastas, grąžinama būsena RetailForce.Fiscalisation.Implementation. Germany.Tse.TseStatus.Critical.
PUT /api/v1/management/germany/ {clientId}/tse/updateTime	M	Atnaujina laiką TSE pagal dabartinį kompiuterio laiką.
GET /api/v1/management/germany/ {clientId}/tse/tar	O	Eksportuoja tar failus iš pirminės TSE. Būtina neprisijungusioms sistemoms.
GET /api/v1/management/germany/ {clientId}/taxonomy	O	Eksportuoja taksonomiją (DSFinV-K eksportas) ir pateikia ją kaip atsisiuntimo failą (zip formato). Būtina neprisijungusioms sistemoms.
GET /api/v1/management/germany/ {clientId}/tse/listTransactions	R	Grąžina visas aktyvias (pradėtas) transakcijas TSE. Rekomenduojama atvirų sandorių sekimui (visi pradėti sandoriai turi būti išsaugoti arba atšaukti)
DELETE /api/v1/management/germany/ {clientId}/tse/listTransactions	O	Uždaro pradėtas TSE transakcijas
GET /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures/count	O	Grąžina neprisijungusių sandorių skaičių (= sandoriai, kurie nebuvo išsiųsti į TSE, nes TSE yra neprisijungusi – nepasiekiama)
GET /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures	O	Grąžina visas atviras neprisijungus atliktas parašas, kurios yra išsaugotos dabartiniam TSE.
PUT /api/v1/management/germany/ {clientId}/tse/openOfflineSignatures	O	Apdoroja dar atviras neprisijungus pasirašytas parašas.
PUT /api/v1/management/germany/ {clientId}/tse/replace	R	Pakeičia esamą TSE nurodytam klientui nauju (pvz., jei senasis TSE yra sugadintas arba sertifikatas nebegalioja).
POST /api/v1/management/germany/ {clientId}/tse/selftest	R	Atlieka sinchroninį nurodytos kasos aparato savikontrolės testą TSE (kasos aparatas yra neprivalomas).
POST /api/v1/management/germany/ {clientId}/tse/updateFirmware	R	Atnaujina programinę įrangą „swissbit“ aparatinės TSE įrangoje.

ManagementController_Spain

Trumpas aprašymas: Ispanijos fiskalizacijos valdymo funkcijos.

Galutinis taškas	Tipas	Aprašymas
GET /api/v1/management/spain/ {clientId}/ticketBai	R	Grąžina išsaugotus „TicketBai“ failus (siųstus failus, atsakymo failus, klaidų failus) kaip ZIP failą.
GET /api/v1/management/spain/ {clientId}/ticketBai/{documentNumber}	R	Grąžina išsaugotus „TicketBai“ failus pagal prašomą dokumento numerį (siųstus failus, atsakymo failus, klaidų failus) kaip ZIP failą.

Receipts

Trumpas aprašymas: naudojama skaitmeniniams kvitams siųsti per tarpinę programinę įrangą į „RetailForce“ debesį.

Šio skirsnio galiniai taškai naudojami skaitmeniniams kasos kvitams siųsti į debesų sistemą (norint naudotis šia paslauga, reikalingos skaitmeninių kvitų licencijos).

聽

Galinis taškas

Tipas

Aprašymas

POST /api/v1/receipts/{clientId}

O/M

Įkelia skaitmeninį kvito failą į debesų sistemą.

Alternatyva: naudokite šį arba kitą šio skirsnio galinį tašką, kad išsiųstumėte skaitmeninius kvitų duomenis.

POST /api/v1/receipts/
{clientId}/{documentGuid}

O/M

Įkelia skaitmeninį kvito failą į debesų sistemą. Naudoja fiskalizacijos metaduomenis.

Alternatyva: naudokite šį arba alternatyvų šio skirsnio galinį tašką, kad siųstumėte duomenis apie skaitmeninius kvitus

Transactions

Trumpas aprašymas: naudojamas fiskalizacijos tikslais dokumentams siųsti į tarpinę programinę įrangą.

Galinis taškas	Tipas	Aprašymas
PUT /api/v1/transactions/createDocument	M	Sukuria dokumentą fiskalinėje vienetoje. Šiuo metodu pats dokumentas nesukuriama, o tik paleidžiamas procesas, pvz., TSE.
POST /api/v1/transactions/storeDocument	M	Išsaugo dokumentą fiskalinėje sistemoje.
POST /api/v1/transactions/cancelDocument	M	Anuliuoja dokumentą fiskalinėje vienetoje.
PUT /api/v1/transactions/reprintDocument/ {clientId}/{documentGuid}	M*	Metodas, skirtas išsaugoti dokumento pakartotinių spausdinimų skaičių, naudojant išsaugotą dokumentą (nuoroda: documentGuid). Alternatyva: kaip alternatyvą naudokite PUT /api/v1/transactions/reprintDocument
PUT /api/v1/transactions/ reprintDocument	M*	Metodas, skirtas iš naujo išsiųsto dokumento pakartotinių spausdinimų skaičiui išsaugoti. Perduodamo dokumento vartotojas turi sutapti su reprintUser (ne originalaus dokumento vartotoju). Alternatyva: kaip alternatyvą naudokite PUT /api/v1/transactions/reprintDocument/ {clientId}/{documentGuid}.
POST /api/v1/transactions/ revertDocument	R	Nustato visas dokumento reikšmes neigiamomis.
POST /api/v1/transactions/ validateDocument	O	Patikrina dokumento teisingumą ir pateikia visus patikrinimo klaidų sąrašą (arba tuščią sąrašą, jei klaidų nėra).
POST /api/v1/transactions/ validateDocumentString	O	Siunčia dokumentą JSON String patikrinimui į paslaugą.
GET /api/v1/transactions/document/ {clientId}/start	R	Grąžina pradinio dokumento duomenis nurodytam klientui. Pradinis dokumentas naudojamas kliento ir fiskalinės vieneto inicijavimui (/api/v1/management/clients/initialize)
POST /api/v1/transactions/display/{clientId}	M*	Rodo tekstą kliento ekrane. Palaikoma tik tose šalyse, kuriose naudojami klientų ekranai. Kitose šalyse šis iškvietimas neturi jokio poveikio (tačiau jį galima iškvieti).
PUT /api/v1/transactions/printer/ {clientId}/openDrawer	M*	Atidaro kasos stalčių, jei kasos stalčius yra prijungtas prie fiskalinio spausdintuvo.
GET /api/v1/transactions/getQrCodeBase64	O	Grąžina QR kodo duomenis kaip Base-64 koduotą eilutę iš duomenų
POST /api/v1/transactions/auditlog	M*	Prideda audito žurnalo įrašą prie fiskalinio kliento.
GET /api/v1/transactions/auditlog/{clientId}	M*	Grąžina visus audito žurnalo įrašus, kurie buvo užklausyti pagal fromDate/tillDate.
GET /api/v1/transactions/document/ {clientId}/{documentGuid}	R	Grąžina prašomą dokumentą, jei jis yra saugomas vidinėje atmintyje.
HEAD /api/v1/transactions/document/ {clientId}/{documentGuid}	O	Grąžina informaciją, ar prašomas dokumentas yra vidinėje dokumentų saugykloje.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}	O	Grąžina prašomą dokumentą, jei jis yra saugomas vidinėje saugykloje.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}	O	Grąžina informaciją, ar prašomas dokumentas yra vidinėje dokumentų saugykloje.
GET /api/v1/transactions/document/ {clientId}/last	O	Grąžina paskutinį iš dokumentų saugyklos išsaugotą dokumentą
GET /api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}	O	Grąžina prašomą dokumentą, jei jis yra saugomas vidinėje saugykloje.
GET /api/v1/transactions/document/ {clientId}/{documentGuid}/response	R	Grąžina atsakymą (fiscalResponse) į prašomą dokumentą, jei jis yra išsaugotas vidinėje atmintyje.
GET /api/v1/transactions/document/ {clientId}/id/{documentId}/response	O	Grąžina atsakymą (fiscalResponse) į prašomą dokumentą, jei jis yra išsaugotas vidinėje atmintyje.
GET /api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response	O	Grąžina prašomą dokumentą, jei jis yra išsaugotas vidinėje atmintyje.

聽