Ta članek ponuja pregled funkcij API-ja storitve RetailForce Fiscal Service (stanje: release 1.6.3). Zahtevane parametre posameznih končnih točk si lahko ogledate prek swaggerja (npr. http://localhost:7678/swagger/index.html) po namestitvi Fiscal Middleware.
API je razdeljen na različna področja, ki se uporabljajo za različne namene in izdelke.
Informacije v stolpcu »Type«:
- O ... neobvezno
- M ... obvezno / zahtevano
- M* ... obvezno v nekaterih državah ali pod določenimi pogoji
- R ... priporočeno
Naslovi se nanašajo na ustrezne oddelke v swaggerju. Za nekatere končne točke boste našli povezave do dodatnih informacij.
Arhiv
Kratek opis: Funkcija arhiviranja že fiskaliziranih podatkov.
Končne točke v tem poglavju se uporabljajo za prenos podatkov v RetailForce Secure Archive.
| Končna točka | Tip | Opis |
| POST /api/v1/archive/de/{clientId} | O | Ta metoda se uporablja za nalaganje več datotek v Cloud arhiv. |
| GET /api/v1/archive/de/{clientId} | O | Uporablja se za prenos prej arhiviranih podatkov (datotek) iz Cloud arhiva. |
Varnostno kopiranje
Kratek opis: Funkcija arhiviranja za poljubne POS-podatke
Končne točke v tem poglavju so namenjene nalaganju poljubnih podatkov v Cloud arhiv – za storitev/izdelek: »POS Archive«. Za uporabo te storitve je potrebna licenca za varnostno kopiranje.
| Končna točka | Tip | Opis |
| POST /api/v1/backup/{clientId} | O | Ta metoda ustvari varnostno kopijo določene mape v Cloud arhivu. |
| POST /api/v1/backup/{clientId}/restore | O | Obnovi prej arhivirano (varnostno kopijo) datoteko na določeno mesto. |
| GET /api/v1/backup/{clientId}/restore | O | Vrne URL za prenos, ki se lahko uporabi za prenos zahtevane varnostne kopije iz Cloud arhiva. |
Zapiranje
Kratek opis: Funkcije za zaključevanje blagajn.
Ta razdelek ponuja različne administrativne funkcije za obračun blagajne. Za več informacij o zaključnih vnosih ob koncu dneva glejte članek: Dnevni zaključek blagajne,
| Končna točka | Tip | Opis |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
Vknjiži začetno stanje zaloge za zaključni izpis blagajne. Vknjiži le vplačilo, stanja gotovine ne poravna. Alternativa: Blagajna lahko kot alternativa knjiži tudi dokument: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Vknjiži razliko v gotovini v sistem za davčno poročanje. Alternativa: Blagajna lahko namesto tega vknjiži tudi dokument z BusinessTransactionType [91] = CashDifference. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Evidentira prenos denarja iz blagajniškega sistema v banko (ali kateri koli drugi cilj). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Vrne dejansko stanje plačil določenega klienta. To se izračuna na podlagi poslanih dokumentov (poleg računov za prodajo in vračila, vplačil in izplačil itd.). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Preveri dejansko stanje plačil za to blagajno in vrne seznam plačil z razliko (ali prazen seznam, če razlike ni). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Zaključi tekoči dan z zaključnim poročilom. Zaključek se opravi na podlagi dokumentov, poslanih stranki od zadnjega zaključka. Blagajniški sistem v zameno ne prejme zaključnega poročila! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Vrne dokument o zaključku dneva za tekoči dan. Vrnjeni dokument je treba shraniti (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Vrne datum in čas zadnjega zaključka za določenega klienta (terminal) |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Vrne informacijo o tem, ali je treba na določenem terminalu opraviti dnevno zaključevanje. (Odvisno od RetailForce.Fiscalisation.Implementation. |
Informacije
Kratek opis: uporablja se za poizvedovanje posebnih informacij
| Končna točka | Tip | Opis |
| GET /api/v1/information/version | O | Vrne dejansko različico (SW) programske opreme (fiskalno middleware). |
| GET /api/v1/information/version/{clientId} | O | Vrne različico državnega modula za danega klienta. |
| GET /api/v1/information/countryProperties | O | Vrne lastnosti fiscalCountryProperties za zahtevano državo. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Vrne lastnosti fiscalCountryProperties za navedenega klienta. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Vrne edinstveno ID blagajne (storeNumber/terminalNumber). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Vrne status zahtevane davčne stranke. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Vrne seznam dostopnih licenc za zahtevanega klienta. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Vrne zahtevek za licenco za zahtevanega klienta. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Vrne ustrezno identifikacijsko številko Vat za zahtevani odstotek ter datum in čas. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Vrne obvezna polja za tip, ki ga določa typeName, za dano izvedbo v državi. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Če je nastavljeno na true, se bo vsak dokument o napaki shranil v imenik fiskalnega klienta. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Vrne, ali je omogočena možnost RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Vrne vse ID-je števcev zmogljivosti za danega klienta |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Ponastavi vse povprečne podatke za danega klienta. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Vrne povprečne podatke za zahtevano ID merilnika zmogljivosti. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Ponastavi povprečne podatke za določenega klienta in določen merilnik zmogljivosti. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Omogoči ali onemogoči sledenje datotek zmogljivosti. Sledenje datotek zmogljivosti je privzeto onemogočeno. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Vrne vse oznake informacij o napredku za danega klienta. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Vrne informacije o napredku za danega klienta in oznako. |
Upravljanje
Kratek opis: Funkcije upravljanja, zagon in izklop
| Končna točka | Tip | Opis |
| PUT /api/v1/management/clients | O/M |
Ustvari novega klienta v skladišču konfiguracij. Konfiguracijski objekt mora pripraviti POS-sistem. Konfiguracija klienta je potrebna za delovanje. Uporabite bodisi to končno točko bodisi:
|
| POST /api/v1/management/clients | O |
Posodobi konfiguracijo stranke, ki jo je ustvaril sistem blagajne v skladišču konfiguracij. |
| GET /api/v1/management/clients | O |
Vrne vse kliente, navedene v skladišču konfiguracij. Lahko se uporabi tudi pri uporabi konfiguracije v Cloudu. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Ustvari novega klienta s konfiguracijo, pripravljeno v Cloudu, ali pa naloži obstoječega klienta. Za delovanje je potrebna konfiguracija klienta. Uporabite:
|
|
PUT
/api/v1/management/clients/ byCloud/ID |
O |
Ustvari client, ki naloži konfiguracijske podatke iz Clouda. Alternativa: alternativna končna točka za PUT /api/v1/management/clients in PUT /api/v1/management/clients/byCloud. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Posodobi konfiguracijo odjemalca s pridobitvijo konfiguracije odjemalca iz Clouda. Uporablja se, ko je bila konfiguracija, pripravljena v Cloudu, posodobljena in jo mora davčni odjemalec ponovno prenesti (posodobitev). |
|
POST /api/v1/management/clients/withCloud |
O/M |
Ustvari novega klienta v upravljanju fiskalnega modula in to stranko doda v konfiguracijo Cloud. Client se ustvari v lokalnem skladišču konfiguracij, konfiguracijski objekt pa se nato naloži v sistem v Cloudu. Opomba: V podatkih stranke mora biti določen distributor, ki mora imeti dovoljenje za ustvarjanje novih klientov. |
|
POST /api/v1/management/cloud/ connect |
M* |
Vzpostavi povezavo v oblaku za določeno stranko in naloži zaupanja vreden fiskalni modul v predpomnilnik. Potrebno za sisteme, ki uporabljajo funkcije v oblaku. Potrebno po vsakem ponovnem zagonu POS-sistema. |
|
POST
/api/v1/management/cloud/ updateLicense |
O |
Posodobi trenutni licenčni ključ v konfiguraciji fiskalnega klienta (tudi na disku). Potrebno, če so bile spremenjene licence v konfiguraciji v Cloudu. |
| HEAD /api/v1/management/Cloud/queue | R |
Metoda za zagon ali zaustavitev obdelave čakalne vrste v oblaku (za vse stranke). Ukaz »Stop« ustavi obdelavo po končanem dejanskem nalaganju. Start takoj začne obdelavo čakalne vrste. Če je obdelava čakalne vrste v Cloud ustavljena, jo morate ponovno zagnati, razen če se storitev ponovno zažene (v tem primeru se obdelava v Cloud ponovno aktivira). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Vrne konfiguracijo določenega odjemalca. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Izbriše določenega klienta Pozor: uporabljajte previdno! |
| GET /api/v1/management/clients/ID | O |
Vrne edinstveno ID stranke za zahtevane parametre. Za zahtevo uniqueClientId se lahko uporabijo različni parametri. |
|
GET
/api/v1/management/clients/ LicenseConsumerId |
O |
Vrne ID uporabnika licence za dano identifikacijo podjetja. Vrnjene so le identifikacijske številke uporabnika licence (LicenseConsumerId), ki so že shranjene v konfiguracijskem skladišču. |
|
GET
/api/v1/management/clients/ validate |
O |
Preveri, ali podatki o danem clientu ustrezajo potrebnim konfiguracijam, specifičnim za posamezno državo. Uporablja se za preverjanje konfiguracije, ki jo je ustvaril sistem blagajne, pred uporabo /api/v1/management/clients. Preverjanje konfiguracije v oblaku se izvaja v oblačnem sistemu. |
|
POST /api/v1/management/clients/ initialize |
M |
Inicializira fiskalno enoto (in morebitno strojno opremo ter morebitno prijavo finančnim organom). Inicializacija se opravi prek začetnega računa (začetnega dokumenta), ki ga je mogoče pridobiti z uporabo končne točke GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
Prenese stranko od drugega ponudnika fiskalnih storitev. Uporablja se pri prehodu od drugega ponudnika middleware-ja k RetailForce Upoštevajte podprte sisteme. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
Prenese stranko od drugega ponudnika fiskalnih storitev in izvede uvoz datoteke. Upoštevajte podprte sisteme! |
|
POST
/api/v1/management/clients/ decommission |
R |
Ukinitev fiskalnega klienta (in morebitne strojne opreme ter morebitne prijave finančnim organom). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Naloži Support Package (datoteke z dnevniki) v Cloud za danega klienta. Ta končna točka je potrebna za uporabo funkcije »Naloži Support Package« v sistemu na Cloud platformi. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Varnostno kopira clienta v datoteko z danim filename (varnostna kopija v obliki ZIP-datoteke). Če je v uporabi nalaganje v oblak, se obdelava čakalne vrste v oblaku ustavi in ponovno zažene (čakalna vrsta v oblaku se ponovno inicializira). Pozor: Upoštevajte, da se bo obdelava čakalne vrste v Cloudu po varnostnem kopiranju nadaljevala, če client ni odstranjen. Če so bile katere koli datoteke pred varnostnim kopiranjem, so tudi del varnostne kopije in bodo morda naložene dvakrat, če se client obnovi. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Obnovi client (z vsemi podatki) iz navedene datoteke ZIP z varnostno kopijo. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Ustvari novega klienta s konfiguracijo iz Clouda / ali naloži obstoječega klienta. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/ID |
O |
Ustvari novega klienta s konfiguracijo iz Clouda / ali naloži obstoječega klienta. |
| POST /api/v1/management/clients/ {clientId}/GlobalShortId | O |
Ustvari novo ali vrne obstoječo, globalno edinstveno ID-jo za zadevnega stranka. Poleg tega se za zadevnega stranka aktivira izdaja retailForceReceiptId. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Shrani zunanje potrdilo v shrambo potrdil fiskalnega modula. Potrebno za sisteme, ki NE uporabljajo funkcij RetailForce Cloud v državah z davčnim sistemom, kjer se v okviru fiskalizacije uporabljajo programska potrdila (Slovenija, Hrvaška, Španija,…) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Vrne, ali ima zahtevani client zahtevano licenco za dostop. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Vrne, ali ima zahtevani client zahtevano licenco. |
ManagementController_Austria
Kratek opis: Funkcije upravljanja za avstrijsko fiskalizacijo.
| Končna točka | Tip | Opis |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
Ustvari uporabniški ključ AES za tega klienta in ga vrne. Ključ AES se shrani tudi v konfiguracijo klienta. Opomba: Uporabniški ključ AES bo ustvaril fiskalni client samodejno. Končna točka je potrebna le, če je treba ključ AES ustvariti ročno. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Vrne ključ AES za danega klienta. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Izvozi vse vrstice prejemkov iz lokalnega dnevnika zbiranja podatkov (DEP §7 RKSV). Potrebno za sisteme, ki delujejo brez internetne povezave (sistemi, ki NE uporabljajo arhiviranja davčnih podatkov v Cloudu). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
Izvozi vse podatke, zahtevane za protokol DEP131 (DEP §131 BAO), iz lokalno shranjenih podatkov. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/startReceipt |
R |
Vrne začetni račun za tega klienta. Sistem blagajne mora biti sposoben na zahtevo predložiti začetni račun (začetni potrdilo) med davčno revizijo; če sistem POS ni shranil začetnega računa, ga je mogoče zahtevati prek te končne točke. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/monthReceipts |
R |
Vrne vse mesečne račune v zahtevanem časovnem okviru. Blagajniški sistem mora biti sposoben na zahtevo zagotoviti mesečne račune med davčno revizijo; če sistem POS teh dokumentov ni shranil, jih je mogoče zahtevati prek te končne točke. |
|
GET
/api/v1/management/austria/ {clientId}/Fon/certificate |
O |
Vrne vse naprave za podpisovanje in informacijo, ali so aktivirane v sistemu FinanzOnline (Fon) ali ne. |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Registrira konfigurirano napravo za podpis v Fon (če je kakšna konfigurirana) ali napravo za podpis, identificirano s certificateSerial. Opomba: Če se uporabljajo storitve RetailForce Cloud, se certifikati samodejno registrirajo v portalu FinanzOnline (Fon) (à potrebna so pooblastila za uporabnika spletne storitve blagajne!); končna točka je potrebna le, če je treba registracijo opraviti ročno. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Odjavi nastavljeno napravo za podpis pri Fon (če je nastavljena) ali napravo za podpis, identificirano s certificateSerial. Pozor: uporabljajte previdno! |
|
GET
/api/v1/management/austria/ {clientId}/fon/document |
R |
Preveri veljavnost zadnjega podpisanega dokumenta v DEP na FinanzOnline (Fon). |
|
GET
/api/v1/management/austria/ {clientId}/fon/document/{depDocument} |
R |
Preveri veljavnost navedenega dokumenta DEP (QR-koda) v sistemu Fon. |
|
GET
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Vrne, ali je blagajna dejanskega klienta aktivirana pri Fon. Potrebno za sisteme, ki delujejo brez internetne povezave. |
|
POST
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Registracija blagajniškega sistema pri Fon za trenutnega klienta. Potrebno za sisteme brez internetne povezave. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Odjava blagajne pri Fon za zadevnega klienta. Potrebno za sisteme brez internetne povezave. Pozor: uporabljajte previdno! |
ManagementController_Bulgaria
Kratek opis: Funkcije upravljanja za bolgarsko fiskalizacijo.
| Končna točka | Tip | Opis |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Pošlje ukaz za zaključek (Z) na fiskalni tiskalnik. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Pošlje ukaz za sinhronizacijo časa (L) na fiskalni tiskalnik. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/KLEN | R |
To funkcijo je mogoče uporabiti za ustvarjanje tako imenovanega poročila KLEN. (od v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Ta funkcija se uporablja za tiskanje
(od različice v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Ta funkcija se uporablja za izpis tako imenovanega poročila BLOCK. (od v1.8.3) |
ManagementController_Denmark
Kratek opis: Funkcije za upravljanje danske fiskalizacije.
| Končna točka | Tip | Opis |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
Izvozi danski format SAF-T v navedeni stream. |
ManagementController_France
Kratek opis: Funkcije upravljanja za francosko fiskalizacijo.
| Končna točka | Tip | Opis |
|
GET
/api/v1/management/france/ eventlog/{clientId} |
M |
Vrne vse zahtevane vpise v revizijskem dnevniku po datumu. |
|
GET
/api/v1/management/france/ archive/{clientId} |
M |
Vrne lokalno shranjene arhive za zaprtje. |
|
POST
/api/v1/management/france/ archive/{clientId}/verify |
M |
Metoda za preverjanje francoskega arhiva. |
ManagementController_Germany
Kratek opis: Funkcije upravljanja za nemško fiskalizacijo.
| Končna točka | Tip | Opis |
| GET /api/v1/management/germany/TSE | R |
Vrne niz priključenih lokalnih naprav TSE in njihov status. |
|
POST
/api/v1/management/germany/ TSE/{TseSerial}/selftest |
R |
Izvede sinhroni samopreizkus za dano blagajno na napravi TSE (blagajna je neobvezna). |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/connectTest |
R |
Opravi testno povezavo z določenim TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/listClients |
O |
Vrne vse kliente, navedene v TSE določene stranke. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/status |
R |
Vrne stanje TSE. Če ni najden noben fiskalni modul, se vrne stanje RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/updateTime |
M |
Posodobi čas na TSE na dejanski čas računalnika. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/tar |
O |
Izvozi tar datoteke iz primarnega TSE. Potrebno za sisteme brez internetne povezave. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Izvozi taksonomijo (DSFinV-K export) in jo vrne kot datoteko za prenos (v formatu zip). Potrebno za sisteme brez internetne povezave. |
|
GET /api/v1/management/germany/ {clientId}/TSE/listTransactions |
R |
Vrne vse aktivne (začete) transakcije na TSE. Priporočljivo za spremljanje odprtih transakcij (vse začete transakcije je treba shraniti ali preklicati). |
| DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions | O |
Prekliče aktivne (začete) transakcije na TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures/count |
O |
Vrne število offline transakcij (= transakcij, ki niso bile poslane na TSE zaradi offline TSE – okvare ali nedostopnosti). |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Vrne vse odprte offline podpise, shranjene za trenutni TSE. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Obdela odprte offline podpise. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/replace |
R |
Nadomesti trenutni TSE za danega klienta z novim (na primer, če je stari TSE poškodovan ali je potekel certifikat). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/selftest |
R |
Izvede sinhroni samopreizkus za dano blagajno na TSE (blagajna je neobvezna). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/updateFirmware |
R |
Posodobi vgrajeno programsko opremo na napravi hardware TSE podjetja swissbit. |
ManagementController_Spain
Kratek opis: Funkcije upravljanja za špansko fiskalno evidentiranje.
| Končna točka | Tip | Opis |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI |
R |
Vrne shranjene datoteke TicketBAI (poslane datoteke, odgovorne datoteke, datoteke z napakami) v obliki datoteke zip. |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI/{DocumentNumber} |
R |
Vrne shranjene datoteke TicketBAI za zahtevano številko dokumenta (poslane datoteke, datoteke z odgovori, datoteke z napakami) v obliki datoteke zip. |
Potrdila
Kratek opis: uporablja se za pošiljanje digitalnih potrdil v RetailForce Cloud prek middleware.
Končne točke v tem razdelku se uporabljajo za pošiljanje dokumentov digitalnih potrdil v Cloud sistem (za uporabo te storitve so potrebne licence za digitalna potrdila!).
| Končna točka | Tip | Opis |
| POST /api/v1/receipts/{clientId} | O/M |
Naloži datoteko z digitalnim računom v Cloud sistem. Alternativa: Za pošiljanje podatkov o digitalnih računih uporabite to ali alternativno končno točko v tem razdelku. |
|
POST
/api/v1/receipts/ {clientId}/{DocumentGuid} |
O/M |
Naloži digitalno datoteko v Cloud sistem. Uporablja Metadata o fiskalizaciji. Alternativa: Za pošiljanje podatkov o digitalnih računih uporabite to ali alternativno končno točko v tem poglavju. |
Transakcije
Kratek opis: uporablja se za pošiljanje dokumentov v middleware v okviru fiskalizacije.
| Končna točka | Tip | Opis |
| PUT /api/v1/transactions/createDocument | M |
Ustvari dokument v enoti za fiskalizacijo. Ta metoda sama ne ustvari dokumenta, temveč zgolj sproži postopek, na primer na TSE. |
| POST /api/v1/transactions/storeDocument | M |
Shrani dokument v fiskalno enoto. |
| POST /api/v1/transactions/cancelDocument | M |
Prekliče dokument v fiskalni enoti. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid} |
M* |
Metoda za shranjevanje števila ponatisov dokumenta z uporabo shranjenega dokumenta (sklic: DocumentGuid). Alternativa: lahko uporabite tudi PUT /api/v1/transactions/reprintDocument |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Metoda za shranjevanje števila ponatisov dokumenta s ponovnim pošiljanjem dokumenta. Uporabnik prenesenega dokumenta mora biti uporabnik, ki izvaja ponatis (ne uporabnik izvirnega dokumenta). Alternativa: lahko uporabite tudi PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Povrne dokument v prvotno stanje (vse vrednosti postanejo negativne). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Preveri veljavnost dokumenta in vrne vse napake pri preverjanju veljavnosti (ali prazen seznam, če ni napak pri preverjanju veljavnosti). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Pošlji dokument v formatu JSON storitvi za preverjanje veljavnosti dokumenta. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Vrne začetni dokument za danega klienta. Začetni dokument se uporablja za inicializacijo stranke in davčne enote (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Prikaže besedilo na zaslonu za davčne stranke. Podprto le v državah, ki uporabljajo fiskalni zaslon za stranke. V drugih državah ta klic ne povzroči ničesar (vendar ga je mogoče izvesti). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Odpre predal, če je ta priključen na fiskalni tiskalnik. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Vrne podatke o QR-kodi kot string, kodiran v bazi 64, iz podatkov. |
| POST /api/v1/transactions/AuditLog | M* |
Dodaja revizijski dnevnik k fiskalnemu odjemalcu. |
| GET /api/v1/transactions/AuditLog/{clientId} | M* |
Vrne vse revizijske zapise, poizvedene po fromDate/tillDate. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
R |
Vrne zahtevani dokument, če je shranjen v notranjem pomnilniku. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
O |
Vrne, ali zahtevani dokument obstaja v notranjem skladišču dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Vrne zahtevani dokument, če je shranjen v notranjem skladišču. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId} |
O |
Vrne, ali zahtevani dokument obstaja v notranjem skladišču dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Vrne zadnji shranjeni dokument iz skladišča dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Vrne zahtevani dokument, če je shranjen v notranjem pomnilniku. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid}/response |
R |
Vrne zahtevani odgovor na dokument, če je shranjen v notranjem pomnilniku. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId}/response |
O |
Vrne odgovor na zahtevan dokument, če je shranjen v notranjem pomnilniku. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Vrne zahtevani dokument, če je shranjen v notranjem pomnilniku. |
Ta članek je bil samodejno preveden.
Komentar
0 komentarjev
Za dodajanje komentarja prosimo kliknite Vpis.