Tento článok poskytuje prehľad funkcií API služby RetailForce Fiscal Service (release: 1.6.3). Požadované parametre jednotlivých koncových bodov si môžete prezrieť prostredníctvom swaggeru (napr. http://localhost:7678/swagger/index.html) po inštalácii Fiscal Middleware.
Rozhranie api je rozdelené do rôznych oblastí, ktoré slúžia na rôzne účely a pre rôzne produkty.
Informácie v stĺpci „Typ“:
- O ... voliteľné
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých krajinách alebo za určitých podmienok
- R ... odporúčané
Nadpisy odkazujú na príslušnú sekciu v swaggeri. Pri niektorých koncových bodoch nájdete odkazy na ďalšie informácie.
Archív
Stručný popis: Funkcia archivácie už zdanených údajov.
Koncové body v tejto sekcii sa používajú na prenos údajov do archívu RetailForce.
| Koncový bod | Typ | Popis |
| POST /api/v1/archive/de/{clientId} | O | Táto metóda sa používa na nahratie viacerých súborov do cloudového archívu. |
| GET /api/v1/archive/de/{clientId} | O | Používa sa na stiahnutie predtým archivovaných údajov (súborov) z cloudového archívu. |
Zálohovanie
Stručný popis: Funkcia archivácie pre ľubovoľné údaje z POS
Koncové body v tejto sekcii slúžia na nahrávanie ľubovoľných údajov do Cloud archívu – pre službu/produkt: „POS Archive“. Na používanie tejto služby je potrebná licencia na zálohovanie.
| Koncový bod | Typ | Popis |
| POST /api/v1/backup/{clientId} | O | Táto metóda zálohuje danú zložku do cloudového archívu. |
| POST /api/v1/backup/{clientId}/restore | O | Obnoví predtým archivovaný (zálohovaný) súbor do konkrétneho umiestnenia. |
| GET /api/v1/backup/{clientId}/restore | O | Vráti URL na stiahnutie, ktorú je možné použiť na stiahnutie požadovaného záložného súboru z cloudového archívu. |
Uzatváranie
Stručný popis: Funkcie uzatvárania pokladníc.
Táto sekcia poskytuje rôzne administratívne funkcie pre účtovníctvo pokladne. Ďalšie informácie o záznamoch na konci dňa nájdete v článku: Denné uzatvorenie pokladne,
| Koncový bod | Typ | Popis |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
Zaznamená počiatočný stav hotovosti pre záverečný výpis pokladne. Zaznamená len vklad, nevyrovná stav hotovosti. Alternatíva: Pokladňa môže alternatívne zaúčtovať aj doklad: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Zaúčtuje hotovostný rozdiel do systému fiskalizácie. Alternatíva: Pokladňa môže alternatívne zaúčtovať aj doklad s BusinessTransactionType [91] = CashDifference. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Zaúčtuje prevod peňazí z pokladničného systému do banky (alebo na akékoľvek iné miesto). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Vráti skutočný stav platieb konkrétneho klienta. Ten sa vypočíta na základe odoslaných dokladov (okrem pokladničných blokov z predaja a vrátenia tovaru, vkladov a výberov atď.). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Skontroluje skutočný stav platieb pre túto pokladňu a vráti zoznam platieb s rozdielom (alebo prázdny zoznam, ak žiadny rozdiel nie je). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Uzavrie aktuálny deň pomocou záverečného výpisu. Uzávierka sa vykonáva na základe dokumentov odoslaných klientovi od poslednej uzávierky. Pokladničný systém nedostáva záverečný výpis späť! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Vráti dokument o ukončení dňa pre aktuálny deň. Vrátený dokument sa musí uložiť (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Vráti dátum a čas posledného uzavretia pre konkrétneho klienta (terminal) |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Vráti informáciu o tom, či sa má na konkrétnom termináli vykonať denné uzatvorenie. (V závislosti od RetailForce.Fiscalisation.Implementation. |
Informácie
Stručný popis: slúži na vyžiadanie špeciálnych informácií
| Koncový bod | Typ | Popis |
| GET /api/v1/information/version | O | Vráti aktuálnu verziu (SW) softvéru (fiskálne middleware). |
| GET /api/v1/information/version/{clientId} | O | Vráti verziu modulu krajiny daného klienta. |
| GET /api/v1/information/countryProperties | O | Vráti vlastnosti fiscalCountryProperties pre požadovanú krajinu. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Vráti vlastnosti fiscalCountryProperties pre daného klienta. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Vráti jedinečné ID pokladne (storeNumber/terminalNumber). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Vráti stav požadovaného daňového klienta. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Vráti zoznam prístupových licencií pre požadovaného klienta. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Vráti žiadosť o licenciu pre požadovaného klienta. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Vráti príslušné identifikačné číslo pre Vat pre požadované percento a dátum/čas. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Vráti povinné polia pre typ zadaný pomocou typeName pre danú implementáciu v krajine. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Ak je nastavené na hodnotu true, akýkoľvek dokument s chybou sa uloží do adresára daňového klienta. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Vráti, či je povolená voľba RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Vráti všetky ID počítadiel výkonu pre daného klienta |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Vynuluje všetky priemerné údaje pre daného klienta. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Vráti priemerné údaje pre požadované ID meradla výkonu. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Vynuluje priemerné údaje pre daného klienta a daný výkonnostný počítadlo. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Zapne alebo vypne sledovanie výkonu do súboru. Sledovanie výkonu do súboru je štandardne vypnuté. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Vráti všetky štítky s informáciami o priebehu pre daného klienta. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Vráti informácie o priebehu pre daného klienta a štítok. |
Správa
Stručný popis: Funkcie správy, uvedenie do prevádzky a vyradenie z prevádzky
| Koncový bod | Typ | Popis |
| PUT /api/v1/management/clients | O/M |
Vytvorí nového klienta v úložisku konfigurácií. Konfiguračný objekt musí byť pripravený systémom POS. Konfigurácia klienta je nevyhnutná pre prevádzku. Použite buď tento koncový bod, alebo:
|
| POST /api/v1/management/clients | O |
Aktualizuje konfiguráciu klienta vytvorenú pokladničným systémom v úložisku konfigurácií. |
| GET /api/v1/management/clients | O |
Vráti všetkých klientov uvedených v úložisku konfigurácií. Možno použiť aj pri konfigurácii v Cloude. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Vytvorí nového klienta s konfiguráciou pripravenou v Cloud / alebo načíta existujúceho klienta. Na prevádzku je potrebná konfigurácia klienta. Použite buď:
|
|
PUT
/api/v1/management/clients/ byCloud/ID |
O |
Vytvorí klienta, ktorý načíta konfiguračné údaje z Cloudu. Alternatíva: alternatívny koncový bod k PUT /api/v1/management/clients a PUT /api/v1/management/clients/byCloud. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Aktualizuje konfiguráciu klienta načítaním konfigurácie klienta z Cloudu. Používa sa v prípade, ak bola konfigurácia pripravená v Cloude aktualizovaná a daňový klient by si ju mal stiahnuť nanovo (aktualizácia). |
|
POST /api/v1/management/clients/withCloud |
O/M |
Vytvorí nového klienta v správe daňového modulu a pridá tohto klienta do konfigurácie v Cloudu. Client sa vytvorí v lokálnom úložisku konfigurácií a objekt konfigurácie sa následne nahraje do Cloud systému. Poznámka: V údajoch klienta musí byť nastavený distributor a distributor musí mať oprávnenie na vytváranie nových klientov. |
|
POST /api/v1/management/cloud/ connect |
M* |
Vytvorí cloudové pripojenie konkrétneho klienta a načíta dôveryhodný fiškálny modul do vyrovnávacej pamäte. Vyžaduje sa pre systémy využívajúce cloudové funkcie. Je potrebné po každom reštarte POS systému. |
|
POST
/api/v1/management/cloud/ updateLicense |
O |
Aktualizuje aktuálny licenčný kľúč v konfigurácii daňového klienta (aj na disku). Vyžaduje sa, ak došlo k zmene licencií v konfigurácii Cloudu. |
| HEAD /api/v1/management/cloud/queue | R |
Metóda na spustenie alebo zastavenie spracovania fronty v Cloude (pre všetkých klientov). Príkaz Stop zastaví spracovanie po dokončení aktuálneho nahrávania. Príkaz „Start“ okamžite spustí spracovanie fronty. Ak je spracovanie cloudovej fronty zastavené, musíte ho reštartovať, pokiaľ sa služba nespustí nanovo (v takom prípade sa spracovanie v cloude aktivuje opäť). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Vráti konfiguráciu konkrétneho klienta. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Odstráni konkrétneho klienta Upozornenie: používajte s opatrnosťou! |
| GET /api/v1/management/clients/ID | O |
Vráti jedinečné ID klienta pre požadované parametre. Na požiadanie o uniqueClientId je možné použiť rôzne parametre. |
|
GET
/api/v1/management/clients/ LicenseConsumerId |
O |
Vráti ID spotrebiteľa licencie pre danú identifikáciu spoločnosti. Vrátené sú len identifikátory LicenseConsumerId, ktoré sú už uložené v konfiguračnom úložisku. |
|
GET
/api/v1/management/clients/ validate |
O |
Overí zadané informácie o kliente, či spĺňajú potrebnú konfiguráciu špecifickú pre danú krajinu. Používa sa na overenie konfigurácie vytvorenej pokladničným systémom pred použitím /api/v1/management/clients. Overenie konfigurácie v cloude zabezpečuje cloudový systém. |
|
POST /api/v1/management/clients/ initialize |
M |
Inicializuje fiskalizačnú jednotku (a prípadný hardvér, ako aj prípadné nahlásenie finančným orgánom). Inicializácia sa vykonáva prostredníctvom úvodného dokladu (počiatočného dokladu), ktorý je možné buď vyžiadať pomocou koncového bodu GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
Prenesie klienta od iného poskytovateľa fiskalizačných služieb. Používa sa pri prechode od iného poskytovateľa fiskálneho middlewaru k RetailForce Poznámka: Podporované systémy. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
Migrácia klienta od iného poskytovateľa fiskalizačných služieb a vykonanie importu súboru. Poznámka: Podporované systémy! |
|
POST
/api/v1/management/clients/ decommission |
R |
Vyradenie daňového klienta (a prípadne hardvéru, ako aj prípadného oznámenia finančným orgánom). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Nahraje Support Package (súbory protokolov) do Cloudu pre daného klienta. Tento koncový bod je potrebný na používanie funkcie „Nahrať Support Package“ v Cloud systéme. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Vytvorí zálohu klienta pod zadaným filename (záloha vo formáte ZIP). Ak sa používa nahrávanie do Cloudu, spracovanie fronty v Cloudu sa zastaví a spustí (a fronta v Cloudu sa reinicializuje). Upozornenie: Ak klient nie je odstránený, spracovanie fronty v Cloudu sa po zálohe obnoví. Ak nejaké súbory neboli pred zálohou, sú súčasťou zálohy a v prípade obnovenia klienta budú pravdepodobne nahraté dvakrát. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Obnoví klienta (so všetkými údajmi) zo zadaného záložného súboru ZIP. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Vytvorí nového klienta s konfiguráciou z Cloudu alebo načíta existujúceho klienta. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/ID |
O |
Vytvorí nového klienta s konfiguráciou z Cloudu alebo načíta existujúceho klienta. |
| POST /api/v1/management/clients/ {clientId}/GlobalShortId | O |
Vygeneruje nové alebo vráti existujúce globálne jedinečné ID pre príslušného klienta. Okrem toho sa pre príslušného klienta aktivuje vydávanie retailForceReceiptId. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Uloží externý certifikát do úložiska certifikátov daňového modulu. Vyžaduje sa pre systémy, ktoré NEPOUŽÍVAJÚ funkcie RetailForce Cloud v krajinách s daňovou povinnosťou, kde sa v rámci fiskalizácie používajú softvérové certifikáty (Slovinsko, Chorvátsko, Španielsko,…) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Vráti informáciu, či požadovaný klient disponuje požadovanou prístupovou licenciou. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Vráti informáciu, či požadovaný klient má požadovanú licenciu. |
ManagementController_Austria
Stručný popis: Funkcie správy pre rakúsku fiskalizáciu.
| Koncový bod | Typ | Popis |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
Vytvorí AES užívateľský kľúč pre tohto klienta a vráti ho. AES kľúč bude tiež uložený v konfigurácii klienta. Poznámka: Používateľský kľúč AES bude automaticky vytvorený daňovým klientom. Tento koncový bod je potrebný len v prípade, ak má byť kľúč AES vytvorený ručne. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Vráti kľúč AES pre daného klienta. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Exportuje všetky riadky príjmových dokladov z lokálneho protokolu o zbere údajov (DEP §7 RKSV). Vyžaduje sa pre offline systémy (systémy, ktoré NEPOUŽÍVAJÚ cloudovú archiváciu daňových údajov). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
Exportuje všetky údaje požadované pre protokol DEP131 (DEP §131 BAO) z lokálne uložených údajov. |
|
GET
/api/v1/management/austria/ {clientId}/DEP/startReceipt |
R |
Vráti počiatočný doklad pre tohto klienta. Pokladničný systém musí byť schopný na požiadanie poskytnúť počiatočný doklad (štartovací doklad) počas daňovej kontroly; ak pokladničný systém neuložil počiatočný doklad, je možné ho vyžiadať prostredníctvom tohto koncového bodu. |
|
GET
/api/v1/management/austria/ {clientId}/dep/monthReceipts |
R |
Vráti všetky mesačné doklady za požadované obdobie. Pokladničný systém musí byť schopný na požiadanie poskytnúť mesačné pokladničné doklady počas daňovej kontroly; ak systém POS tieto dokumenty neuložil, je možné ich vyžiadať prostredníctvom tohto koncového bodu. |
|
GET
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Vráti všetky podpisové zariadenia a informáciu, či sú aktivované v systéme FinanzOnline (Fon) alebo nie. |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Zaregistruje nakonfigurované podpisové zariadenie v systéme Fon (ak je nejaké nakonfigurované) alebo podpisové zariadenie identifikované pomocou certificateSerial. Poznámka: Ak sa používajú služby RetailForce Cloud, certifikáty sa automaticky registrujú v portáli FinanzOnline (Fon) (à sú potrebné prihlasovacie údaje pre používateľa webovej služby pokladne!); tento koncový bod je potrebný len v prípade, ak sa registrácia má vykonať ručne. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Zruší registráciu nakonfigurovaného podpisového zariadenia na portáli Fon (ak je nejaké nakonfigurované) alebo podpisového zariadenia identifikovaného pomocou certificateSerial. Upozornenie: Používajte s opatrnosťou! |
|
GET
/api/v1/management/austria/ {clientId}/fon/document |
R |
Overí posledný podpísaný dokument v DEP na portáli FinanzOnline (Fon). |
|
GET
/api/v1/management/austria/ {clientId}/Fon/document/{depDocument} |
R |
Overí zadaný DEP dokument v úložisku (QR kód) v systéme Fon. |
|
GET
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Vráti informáciu, či je pokladňa aktuálneho klienta aktivovaná v systéme Fon. Vyžaduje sa pre offline systémy. |
|
POST
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Registrácia pokladničného systému v systéme Fon pre aktuálneho klienta. Vyžaduje sa pre offline systémy. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Odstránenie registrácie pokladničného systému v Fon pre daného klienta. Vyžaduje sa pre offline systémy. Upozornenie: používajte s opatrnosťou! |
ManagementController_Bulharsko
Stručný popis: Funkcie správy pre bulharskú fiskalizáciu.
| Koncový bod | Typ | Popis |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Odosiela príkaz na uzavretie (Z) na daňovú tlačiareň. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Odosiela príkaz na synchronizáciu času (L) do fiškálnej tlačiarne. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/KLEN | R |
Túto funkciu je možné použiť na generovanie tzv. správy KLEN. (od verzie v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Táto funkcia slúži na vytlačenie
(od verzie v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Táto funkcia slúži na vytlačenie tzv. BLOCK správy. (od verzie 1.8.3) |
ManagementController_Denmark
Stručný popis: Funkcie správy pre dánsku fiskalizáciu.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
Exportuje formát SAF-T pre Dánsko do zadaného streamu. |
ManagementController_France
Stručný popis: Funkcie správy pre francúzsku fiskalizáciu.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/france/ eventlog/{clientId} |
M |
Vráti všetky požadované záznamy audítorského protokolu podľa dátumu. |
|
GET
/api/v1/management/france/ archive/{clientId} |
M |
Vráti lokálne uložené archívy určené na uzavretie. |
|
POST
/api/v1/management/france/archive/ {clientId}/verify |
M |
Metóda na overenie francúzskeho archívu. |
ManagementController_Germany
Stručný popis: Funkcie správy pre nemeckú fiskalizáciu.
| Koncový bod | Typ | Popis |
| GET /api/v1/management/germany/TSE | R |
Vráti pole pripojených lokálnych zariadení TSE a ich stav. |
|
POST
/api/v1/management/germany/ TSE/{TseSerial}/selftest |
R |
Spustí synchronný autotest pre danú pokladňu na zariadení TSE (pokladňa je voliteľná). |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/connectTest |
R |
Vykoná test pripojenia k danému TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/listClients |
O |
Vráti zoznam všetkých klientov zaregistrovaných na TSE daného klienta. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/status |
R |
Vráti stav TSE. Ak sa nenájde žiadny daňový modul, vráti sa stav RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/updateTime |
M |
Aktualizuje čas na zariadení TSE na aktuálny čas počítača. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/tar |
O |
Exportuje súbory tar z primárneho zariadenia TSE. Potrebné pre offline systémy. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Exportuje taxonómiu (DSFinV-K export) a vráti ju ako súbor na stiahnutie (vo formáte ZIP). Vyžaduje sa pre offline systémy. |
|
GET /api/v1/management/germany/ {clientId}/TSE/listTransactions |
R |
Vráti všetky aktívne (začaté) transakcie na TSE. Odporúča sa na sledovanie otvorených transakcií (všetky začaté transakcie musia byť uložené alebo zrušené). |
| DELETE /api/v1/management/germany/ {clientId}/TSE/listTransactions | O |
Zruší aktívne (začaté) transakcie na burze TSE. |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures/count |
O |
Vráti počet offline transakcií (= transakcie, ktoré neboli odoslané do TSE z dôvodu, že TSE je offline – nefunkčné alebo nedostupné). |
|
GET
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Vráti všetky otvorené offline podpisy uložené pre aktuálny TSE. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/openOfflineSignatures |
O |
Spracuje otvorené offline podpisy. |
|
PUT
/api/v1/management/germany/ {clientId}/TSE/replace |
R |
Nahradí aktuálny TSE pre daného klienta novým (napríklad ak je starý TSE poškodený alebo certifikát vypršal). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/selftest |
R |
Spustí synchronný autotest pre danú pokladňu na TSE (pokladňa je voliteľná). |
|
POST
/api/v1/management/germany/ {clientId}/TSE/updateFirmware |
R |
Aktualizuje firmvér na hardvérovom zariadení TSE od spoločnosti swissbit. |
ManagementController_Spain
Stručný popis: Funkcie správy pre španielsku fiskalizáciu.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/spain/ {clientId}/ticketBai |
R |
Vráti uložené súbory TicketBAI (odoslané súbory, odpovede, súbory s chybami) ako súbor ZIP. |
|
GET
/api/v1/management/spain/ {clientId}/TicketBAI/{DocumentNumber} |
R |
Vráti uložené súbory TicketBAI pre požadované číslo dokumentu (odoslané súbory, súbory s odpoveďami, súbory s chybami) vo forme súboru ZIP. |
Potvrdenia
Stručný popis: slúži na odosielanie digitálnych potvrdeniek do RetailForce Cloud prostredníctvom middleware.
Koncové body v tejto sekcii sa používajú na odosielanie dokumentov digitálnych potvrdeniek do Cloud systému (na používanie tejto služby sú potrebné licencie na digitálne potvrdenky!).
| Koncový bod | Typ | Popis |
| POST /api/v1/receipts/{clientId} | O/M |
Nahraje súbor s digitálnou účtenkou do Cloud systému. Alternatíva: Na odosielanie údajov o digitálnych potvrdeniach použite buď tento, alebo alternatívny koncový bod uvedený v tejto časti. |
|
POST
/api/v1/receipts/ {clientId}/{DocumentGuid} |
O/M |
Nahraje digitálny súbor do Cloud systému. Použitie Metadata fiskalizácie. Alternatíva: Na odosielanie údajov z digitálnych potvrdeniek použite buď tento, alebo alternatívny koncový bod v tejto časti. |
Transakcie
Stručný popis: slúži na odosielanie dokumentov do middleware v kontexte fiskalizácie.
| Koncový bod | Typ | Popis |
| PUT /api/v1/transactions/createDocument | M |
Vytvorí dokument v daňovej jednotke. Táto metóda sama o sebe nevytvorí dokument, iba spustí proces, napríklad na TSE. |
| POST /api/v1/transactions/storeDocument | M |
Uloží dokument do fiskalizačnej jednotky. |
| POST /api/v1/transactions/cancelDocument | M |
Zruší dokument vo fiskalizačnej jednotke. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid} |
M* |
Metóda na uloženie počtu dotlačí dokumentu pomocou uloženého dokumentu (odkaz: DocumentGuid). Alternatíva: alternatívne použite PUT /api/v1/transactions/reprintDocument |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Metóda na uloženie počtu dotlačí dokumentu opätovným odoslaním dokumentu. Používateľom preneseného dokumentu musí byť používateľ, ktorý dokument dotlačí (nie používateľ pôvodného dokumentu). Alternatíva: alternatívne použite PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Vráti dokument do pôvodného stavu (všetky hodnoty sa nastavia na záporné). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Overí dokument a vráti všetky chyby overenia (alebo prázdny zoznam, ak sa nevyskytli žiadne chyby overenia). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Odosiela dokument vo formáte JSON do služby na overenie dokumentu. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Vráti počiatočný dokument pre daného klienta. Počiatočný dokument sa používa na inicializáciu klienta, ako aj fiškálnej jednotky (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Zobrazí text na daňovom displeji zákazníka. Podporované len v krajinách, ktoré používajú fiškálny zákaznícky displej. V ostatných krajinách toto volanie nemá žiadny účinok (ale je možné ho vyvolať). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Otvorí zásuvku, ak je zásuvka pripojená k fiškálnej tlačiarni. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Vráti údaje QR kódu ako string zakódovaný v base64 na základe zadaných údajov. |
| POST /api/v1/transactions/AuditLog | M* |
Pridá auditový záznam k daňovému klientovi. |
| GET /api/v1/transactions/AuditLog/{clientId} | M* |
Vráti všetky záznamy auditu vyhľadané podľa fromDate/tillDate. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
R |
Vráti požadovaný dokument, ak je uložený vo vnútornom úložisku. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{DocumentGuid} |
O |
Vráti informáciu, či požadovaný dokument existuje vo vnútornom úložisku dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{DocumentId} |
O |
Vráti požadovaný dokument, ak je uložený vo vnútornom úložisku. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{DocumentId} |
O |
Vráti informáciu, či požadovaný dokument existuje vo vnútornom úložisku dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Vráti posledný uložený dokument z úložiska dokumentov. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Vráti požadovaný dokument, ak je uložený vo vnútornom úložisku. |
|
GET
/api/v1/transactions/document/ {clientId}/{DocumentGuid}/response |
R |
Vráti požadovanú odpoveď na dokument, ak je uložená vo vnútornom úložisku. |
|
GET
/api/v1/transactions/document/ {clientId}/ID/{DocumentId}/response |
O |
Vráti odpoveď na požiadaný dokument, ak je uložený vo vnútornom úložisku. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Vráti požadovaný dokument, ak je uložený vo vnútornom úložisku. |
Tento článok bol preložený automaticky.
Príspevky
0 komentárov
Ak chcete napísať komentár, prihlásiť sa.