Tento článek poskytuje přehled funkcí API služby RetailForce Fiscal Service (stav: verze 1.6.3). Požadované parametry jednotlivých koncových bodů lze po instalaci fiskálního middlewaru zobrazit prostřednictvím Swaggeru (např. http://localhost:7678/swagger/index.html).
API je rozděleno do různých oblastí, které slouží k různým účelům a pro různé produkty.
Informace ve sloupci „Typ“:
- O ... volitelné
- M ... povinné / vyžadované
- M* ... povinné / vyžadované v určitých zemích nebo za určitých podmínek
- R ... doporučeno
Nadpisy odkazují na příslušnou sekci ve Swaggeru. U některých koncových bodů najdete odkazy na další informace.
Archiv
Stručný popis: Funkce archivace již fiskalizovaných dat.
Koncové body v této sekci slouží k přenosu dat do Secure RetailForce Archive.
| Koncový bod | Typ | Popis |
| POST /api/v1/archive/de/{clientId} | O | Tato metoda slouží k nahrání několika souborů do cloudového archivu. |
| GET /api/v1/archive/de/{clientId} | O | Slouží ke stažení dříve archivovaných dat (souborů) z cloudového archivu. |
Zálohování
Stručný popis: Funkce archivace libovolných dat z pokladních systémů
Koncové body v této sekci slouží k nahrávání libovolných dat do Cloud archivu – pro službu/produkt: „POS Archive“. K využívání této služby je nutná licence pro zálohování.
| Koncový bod | Typ | Popis |
| POST /api/v1/backup/{clientId} | O | Tato metoda zálohuje zadanou složku do cloudového archivu. |
| POST /api/v1/backup/{clientId}/restore | O | Obnoví dříve archivovaný (zálohovaný) soubor do konkrétního umístění. |
| GET /api/v1/backup/{clientId}/restore | O | Vrátí URL adresu ke stažení, kterou lze použít ke stažení požadovaného záložního souboru z cloudového archivu. |
Uzavření
Stručný popis: Funkce pro uzavření pokladny.
Tato sekce poskytuje různé administrativní funkce pro účetnictví pokladny. Další informace o závěrečných zápisech na konci dne najdete v článku: Denní uzávěrka pokladny,
| Koncový bod | Typ | Popis |
|
POST /api/v1/closing/{clientId}/book/ openingStock |
O |
Zaznamená počáteční stav hotovosti pro závěrečný výpis pokladny. Zaznamená pouze vklad, neprovádí přepočítání hotovostního stavu. Alternativa: Jako alternativu může pokladna také zaúčtovat doklad: documentType [11] = PayIn. |
|
PUT
/api/v1/closing/{clientId}/book/ cashDifference |
O |
Zaúčtuje rozdíly v hotovosti do fiskálního systému. Alternativa: Jako alternativu může pokladna také zaúčtovat doklad s BusinessTransactionType [91] = CashDifference. |
|
PUT
/api/v1/closing/{clientId}/book/ cashLift |
O |
Zaznamená převod peněz z pokladního systému do banky (nebo na jakékoli jiné místo určení). |
|
GET /api/v1/closing/{clientId}/ actualStock |
O |
Vrátí aktuální stav plateb konkrétního klienta. Ten se vypočítává na základě předaných dokladů (kromě prodejních a vrácených účtenek, vkladů a výběrů atd.). |
|
POST
/api/v1/closing/{clientId}/ cashpointCheck |
O |
Zkontroluje aktuální stav plateb pro tuto pokladnu a vrátí seznam plateb s rozdílem (nebo prázdný seznam, pokud žádný rozdíl není). |
| POST /api/v1/closing/{clientId}/ cashpointClose |
O |
Uzavře aktuální den pomocí závěrečného výpisu. Uzavření se provádí na základě dokladů odeslaných klientovi od posledního uzavření. Pokladní systém neobdrží zpět závěrečný výpis! |
|
GET
/api/v1/closing/{clientId}/ endofdayDocument |
O |
Vrátí dokument o konci dne pro aktuální den. Vrácený dokument musí být uložen (storeDocument > documentType 99) |
|
GET
/api/v1/closing/{clientId}/ lastClosing |
O |
Vrátí datum a čas posledního uzavření účtu konkrétního klienta (terminálu) |
|
GET
/api/v1/closing/{clientId}/ closingNecessary |
O |
Vrátí informaci o tom, zda má být na konkrétním terminálu provedeno denní uzavření. (V závislosti na RetailForce.Fiscalisation.Implementation. |
Informace
Stručný popis: slouží k dotazování na speciální informace
| Koncový bod | Typ | Popis |
| GET /api/v1/information/version | O | Vrátí aktuální verzi (SW) softwaru (fiskální middleware). |
| GET /api/v1/information/version/{clientId} | O | Vrátí verzi modulu země daného klienta. |
| GET /api/v1/information/countryProperties | O | Vrátí vlastnosti fiscalCountryProperties pro požadovanou zemi. |
|
GET
/api/v1/information/client/{clientId}/ countryProperties |
O | Vrátí vlastnosti fiscalCountryProperties pro daného klienta. |
|
GET
/api/v1/information/client/{clientId}/ UniqueCashRegisterId |
O | Vrátí jedinečné ID pokladny (číslo prodejny/číslo terminálu). |
|
GET
/api/v1/information/client/{clientId}/ status |
O | Vrátí stav požadovaného daňového klienta. |
|
GET
/api/v1/information/client/{clientId}/ accessLicenses |
O | Vrátí seznam přístupových licencí pro požadovaného klienta. |
|
GET
/api/v1/information/client/{clientId}/ licenses |
O | Vrátí nárok na licenci pro požadovaného klienta. |
|
GET
/api/v1/information/client/{clientId}/ getVatIdentification |
R | Vrátí příslušné identifikační číslo pro účely Vat pro požadované procento a datum/čas. |
|
GET
/api/v1/information/client/{clientId}/ documentMandatoryFields/{typeName} |
O | Vrátí povinná pole pro typ zadaný pomocí typeName pro danou implementaci v dané zemi. |
|
POST
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Je-li nastaveno na hodnotu true, budou všechny chybové dokumenty uloženy do adresáře daňového klienta. |
|
GET
/api/v1/information/client/{clientId}/ storeErrorDocumentsToDisk |
R | Vrací, zda je povolena volba RetailForce.Fiscalisation.TrustedFiscalModule. StoreErrorDocumentsToDisk. |
|
GET
/api/v1/information/performance/ {clientId} |
O | Vrátí všechna ID výkonnostních čítačů pro daného klienta |
|
DELETE
/api/v1/information/performance/ {clientId} |
O | Vynuluje všechna průměrná data pro daného klienta. |
|
GET
/api/v1/information/performance {clientId}/{performanceCounterId} |
O | Vrátí průměrné údaje pro požadované ID měřiče výkonu. |
|
DELETE
/api/v1/information/performance/ {clientId}/{performanceCounterId} |
O | Vynuluje průměrné údaje pro daného klienta a daný výkonnostní čítač. |
|
PUT
/api/v1/information/performance/ {clientId}/file |
O | Zapne nebo vypne sledování výkonu do souboru. Sledování výkonu do souboru je ve výchozím nastavení vypnuto. |
|
GET
/api/v1/information/progress/ {clientId} |
O | Vrátí všechny štítky s informacemi o průběhu pro daného klienta. |
|
GET
/api/v1/information/progress/{clientId}/ {label} |
O | Vrátí informace o průběhu pro daného klienta a štítek. |
Správa
Stručný popis: Funkce správy, uvedení do provozu a vyřazení z provozu
| Koncový bod | Typ | Popis |
| PUT /api/v1/management/clients | O/M |
Vytvoří nového klienta v úložišti konfigurací. Konfigurační objekt musí být připraven systémem POS. Konfigurace klienta je nezbytná pro provoz. Použijte buď tento koncový bod, nebo:
|
| POST /api/v1/management/clients | O |
Aktualizuje konfiguraci klienta vytvořenou pokladním systémem v úložišti konfigurací. |
| GET /api/v1/management/clients | O |
Vrátí všechny klienty uvedené v úložišti konfigurací. Lze použít i při konfiguraci v Cloudu. |
|
PUT /api/v1/management/clients/ byCloud |
O/M |
Vytvoří nového klienta s konfigurací připravenou v Cloudu / nebo načte existujícího klienta. Pro provoz je nutná konfigurace klienta. Použijte buď:
|
|
PUT
/api/v1/management/clients/ byCloud/id |
O |
Vytvoří klienta a načte konfigurační data z Cloudu. Alternativa: alternativní koncový bod k PUT /api/v1/management/clients a PUT /api/v1/management/clients/byCloud. |
|
PUT /api/v1/management/clients/ byCloud/{clientId} |
R |
Aktualizuje konfiguraci klienta načtením konfigurace z Cloudu. Používá se, když byla konfigurace připravená v Cloudu aktualizována a měla by být znovu stažena fiskálním klientem (aktualizace). |
|
POST /api/v1/management/clients/withCloud |
O/M |
Vytvoří nového klienta ve správě daňového modulu a přidá tohoto klienta do konfigurace v Cloudu. Klient je vytvořen v lokálním úložišti konfigurace a konfigurační objekt je poté nahrán do Cloud systému. Poznámka: V údajích klienta musí být nastaven distributor a tento distributor musí mít oprávnění k vytváření nových klientů. |
|
POST /api/v1/management/Cloud/ connect |
M* |
Naváže cloudové připojení konkrétního klienta a načte důvěryhodný fiskální modul do mezipaměti. Vyžadováno pro systémy využívající cloudové funkce. Nutné po každém restartu pokladního systému. |
|
POST
/api/v1/management/Cloud/ updateLicense |
O |
Aktualizuje aktuální licenční klíč v konfiguraci fiskálního klienta (také na disku). Vyžadováno, pokud došlo ke změně licencí v konfiguraci Cloudu. |
| HEAD /api/v1/management/Cloud/queue | R |
Metoda pro spuštění nebo zastavení zpracování fronty v Cloudu (pro všechny klienty). Příkaz Stop zastaví zpracování po dokončení aktuálního nahrávání. Příkaz „Start“ okamžitě spustí zpracování fronty. Pokud je zpracování cloudové fronty zastaveno, musíte jej restartovat, pokud není restartována služba (v takovém případě se cloudové zpracování aktivuje znovu). |
|
GET /api/v1/management/clients/ {clientId} |
O |
Vrátí konfiguraci konkrétního klienta. |
|
DELETE
/api/v1/management/clients/ {clientId} |
O |
Odstraní konkrétního klienta Upozornění: používejte s opatrností! |
| GET /api/v1/management/clients/id | O |
Vrátí jedinečné ID klienta pro zadané parametry. K vyžádání uniqueClientId lze použít různé parametry. |
|
GET
/api/v1/management/clients/ licenseConsumerId |
O |
Vrací ID spotřebitele licence pro zadaný identifikátor společnosti. Vrací se pouze ID spotřebitelů licence (licenseConsumerId), která jsou již uložena v úložišti konfigurace. |
|
GET
/api/v1/management/clients/ validate |
O |
Ověří zadané informace o klientovi z hlediska splnění nezbytné konfigurace specifické pro danou zemi. Slouží k ověření konfigurace vytvořené pokladním systémem před použitím /api/v1/management/clients. Ověření konfigurace v cloudu zajišťuje cloudový systém. |
|
POST /api/v1/management/clients/ initialize |
M |
Inicializuje fiskální jednotku (a případně hardware a případné hlášení finančním úřadům). Inicializace se provádí prostřednictvím úvodního dokladu (počátečního dokladu), který lze buď vyžádat pomocí koncového bodu GET /api/v1/transactions/document/ |
|
POST
/api/v1/management/clients/ migrate/{clientId} |
O |
Přenese klienta od jiného poskytovatele fiskalizace. Používá se při přechodu od jiného poskytovatele fiskálního middlewaru k RetailForce Vezměte prosím na vědomí podporované systémy. |
|
POST
/api/v1/management/clients/ migrate/{clientId}/file |
O |
Přenese klienta od jiného poskytovatele fiskalizace a provede import souboru. Vezměte prosím na vědomí podporované systémy! |
|
POST
/api/v1/management/clients/ decommission |
R |
Vyřazení fiskálního klienta z provozu (včetně případného hardwaru a případného oznámení finančním úřadům). |
|
PUT /api/v1/management/clients/ {clientId}/supportPackage |
R |
Nahraje balíček podpory (soubory protokolů) do Cloudu pro daného klienta. Tento koncový bod je nezbytný pro použití funkce „Nahrát balíček podpory“ v Cloud systému. |
|
GET
/api/v1/management/clients/recovery/ {clientId}/backup |
R |
Zálohuje klienta pod zadaným názvem souboru (záloha ve formátu ZIP). Pokud je aktivní nahrávání do Cloudu, zpracování fronty v Cloudu se zastaví a znovu spustí (a fronta v Cloudu se reinicializuje). Upozornění: Vezměte prosím na vědomí, že pokud klient není odstraněn, proces Cloud fronty bude po zálohování obnoven. Pokud některé soubory nebyly před zálohováním, jsou také součástí zálohy a v případě obnovení klienta budou pravděpodobně nahrány dvakrát. |
|
POST
/api/v1/management/clients/ recovery/restore |
R |
Obnoví klienta (včetně všech dat) ze zadaného záložního souboru ZIP. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud |
R |
Vytvoří nového klienta s konfigurací z Cloudu / nebo načte existujícího klienta. |
|
POST /api/v1/management/clients/ recovery/restoreByCloud/id |
O |
Vytvoří nového klienta s konfigurací z Cloudu / nebo načte existujícího klienta. |
| POST /api/v1/management/clients/ {clientId}/globalShortId | O |
Vygeneruje nové nebo vrátí existující globálně jedinečné ID pro daného klienta. Navíc se pro daného klienta aktivuje vydávání retailForceReceiptId. |
|
POST
/api/v1/management/clients/ {clientId}/certificate |
O/M |
Uloží externí certifikát do úložiště certifikátů fiskálního modulu. Vyžadováno pro systémy, které NEPOUŽÍVAJÍ funkce RetailForce Cloud v zemích s daňovou povinností, kde se v rámci fiskalizace používají softwarové certifikáty (Slovinsko, Chorvatsko, Španělsko,…) |
|
GET
/api/v1/management/clients/ {clientId}/licenses/accessLicense |
O |
Vrátí, zda má požadovaný klient požadovanou přístupovou licenci. |
|
GET
/api/v1/management/clients/ {clientId}/licenses/license |
O |
Vrátí, zda požadovaný klient má požadovanou licenci. |
ManagementController_Austria
Stručný popis: Funkce pro správu rakouské fiskalizace.
| Koncový bod | Typ | Popis |
|
POST
/api/v1/management/austria/ {clientId}/aes |
O |
Vytvoří uživatelský klíč AES pro tohoto klienta a vrátí jej. Klíč AES bude také uložen do konfigurace klienta. Poznámka: Uživatelský klíč AES bude automaticky vytvořen fiskálním klientem. Tento koncový bod je nutný pouze v případě, že je třeba klíč AES vytvořit ručně. |
|
GET
/api/v1/management/austria/ {clientId}/aes |
O |
Vrátí klíč AES pro daného klienta. |
|
GET
/api/v1/management/austria/ {clientId}/dep |
O/M |
Exportuje všechny řádky dokladů z lokálně uložených dat z protokolu o shromažďování dat (DEP §7 RKSV). Nezbytné pro offline systémy (systémy, které NEPOUŽÍVAJÍ cloudovou archivaci daňových údajů). |
|
GET
/api/v1/management/austria/ {clientId}/dep131 |
O |
Exportuje všechna data požadovaná pro protokol DEP131 (DEP §131 BAO) z lokálně uložených dat. |
|
GET
/api/v1/management/austria/ {clientId}/dep/startReceipt |
R |
Vrátí počáteční účtenku pro tohoto klienta. Pokladní systém musí být schopen na požádání poskytnout počáteční stvrzenku (start Receipt) během daňové kontroly; pokud pokladní systém počáteční stvrzenku neuložil, lze ji vyžádat pomocí tohoto koncového bodu. |
|
GET
/api/v1/management/austria/ {clientId}/dep/monthReceipts |
R |
Vrátí všechny měsíční účtenky v požadovaném časovém období. Pokladní systém musí být schopen na požádání poskytnout měsíční účtenky během daňové kontroly; pokud pokladní systém tyto dokumenty neuložil, lze je vyžádat pomocí tohoto koncového bodu. |
|
GET
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Vrátí všechna podpisová zařízení a informaci, zda jsou aktivována ve službě FinanzOnline (FON). |
|
POST
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Zaregistruje nakonfigurované podpisové zařízení na portálu FON (pokud je nějaké nakonfigurováno) nebo podpisové zařízení identifikované pomocí certificateSerial. Poznámka: Pokud se používají služby RetailForce Cloud, certifikáty se automaticky registrují v portálu FinanzOnline (FON) (à jsou nutné přihlašovací údaje pro uživatele webové služby pokladny!); tento koncový bod je nutný pouze v případě, že se registrace má provést ručně. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/certificate |
O |
Zruší registraci nakonfigurovaného podpisového zařízení na portálu FON (je-li nějaké nakonfigurováno) nebo podpisového zařízení identifikovaného pomocí certificateSerial. Upozornění: Používejte s opatrností! |
|
GET
/api/v1/management/austria/ {clientId}/fon/document |
R |
Ověří poslední podepsaný dokument v dep na portálu FinanzOnline (FON). |
|
GET
/api/v1/management/austria/ {clientId}/fon/document/{depDocument} |
R |
Ověří zadaný dokument dep (QR kód) ve službě FON. |
|
GET
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Vrátí, zda je pokladna aktuálního klienta aktivována ve službě FON. Nezbytné pro offline systémy. |
|
POST
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Registrace pokladního systému na FON pro aktuálního klienta. Vyžadováno pro offline systémy. |
|
DELETE
/api/v1/management/austria/ {clientId}/fon/cashregister |
O |
Odhlášení pokladního systému u FON pro daného klienta. Vyžadováno pro offline systémy. Upozornění: používejte s opatrností! |
ManagementController_Bulharsko
Stručný popis: Funkce pro správu bulharské fiskalizace.
| Koncový bod | Typ | Popis |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/closing |
M |
Odešle příkaz k uzavření (Z) na fiskální tiskárnu. |
|
POST
/api/v1/management/bulgaria/ {clientId}/commands/synchronizeTime |
M |
Odesílá příkaz k synchronizaci času (L) na fiskální tiskárnu. |
| GET /api/v1/management/bulgaria/ {clientId}/reports/klen | R |
Tuto funkci lze použít k vygenerování tzv. KLEN reportu. (od verze v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/zreport | R |
Tato funkce slouží k vytištění
(od verze v1.8.3) |
| GET /api/v1/management/bulgaria/ {clientId}/reports/block | R |
Tato funkce slouží k vygenerování tzv. BLOCK zprávy. (od verze 1.8.3) |
ManagementController_Denmark
Stručný popis: Funkce pro správu dánského fiskalizačního systému.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/denmark/ {clientId}/saft |
M |
Exportuje dánský formát SAF-T do zadaného proudu. |
ManagementController_France
Stručný popis: Funkce pro správu francouzské fiskalizace.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/france/eventlog/ {clientId} |
M |
Vrátí všechny požadované záznamy auditního protokolu podle data. |
|
GET
/api/v1/management/france/archive/ {clientId} |
M |
Vrátí lokálně uložené archivy určené k uzavření. |
|
POST
/api/v1/management/france/archive/ {clientId}/verify |
M |
Metoda pro ověření francouzského archivu. |
ManagementController_Germany
Stručný popis: Správní funkce pro německou fiskalizaci.
| Koncový bod | Typ | Popis |
| GET /api/v1/management/germany/tse | R |
Vrátí pole připojených lokálních zařízení TSE a jejich stav. |
|
POST
/api/v1/management/germany/tse/ {tseSerial}/selftest |
R |
Spustí synchronní autotest pro danou pokladnu na zařízení tse (pokladna je volitelná). |
|
PUT
/api/v1/management/germany/ {clientId}/tse/connectTest |
R |
Provede test připojení k danému TSE. |
|
GET
/api/v1/management/germany/ {clientId}/tse/listClients |
O |
Vrátí seznam všech klientů uvedených v TSE daného klienta. |
|
GET
/api/v1/management/germany/ {clientId}/tse/status |
R |
Vrátí stav TSE. Pokud není nalezen žádný fiskální modul, je vrácen stav RetailForce.Fiscalisation.Implementation. |
|
PUT
/api/v1/management/germany/ {clientId}/tse/updateTime |
M |
Aktualizuje čas na zařízení TSE na aktuální čas počítače. |
|
GET
/api/v1/management/germany/ {clientId}/tse/tar |
O |
Exportuje soubory tar z primárního zařízení tse. Nezbytné pro offline systémy. |
|
GET
/api/v1/management/germany/ {clientId}/taxonomy |
O |
Exportuje taxonomii (export DSFinV-K) a vrátí ji jako soubor ke stažení (ve formátu ZIP). Nezbytné pro offline systémy. |
|
GET /api/v1/management/germany/ {clientId}/tse/listTransactions |
R |
Vrátí všechny aktivní (zahájené) transakce na tse. Doporučeno pro sledování otevřených transakcí (všechny zahájené transakce je třeba uložit nebo zrušit). |
| DELETE /api/v1/management/germany/ {clientId}/tse/listTransactions | O |
Zruší aktivní (zahájené) transakce na burze. |
|
GET
/api/v1/management/germany/ {clientId}/tse/openOfflineSignatures/count |
O |
Vrátí počet offline transakcí (= transakcí, které nebyly odeslány do TSE z důvodu, že TSE je offline – nefunkční, nedostupná). |
|
GET
/api/v1/management/germany/ {clientId}/tse/openOfflineSignatures |
O |
Vrátí všechny otevřené offline podpisy uložené pro aktuální TSE. |
|
PUT
/api/v1/management/germany/ {clientId}/tse/openOfflineSignatures |
O |
Zpracuje otevřené offline podpisy. |
|
PUT
/api/v1/management/germany/ {clientId}/tse/replace |
R |
Nahradí stávající TSE pro daného klienta novým (například pokud je starý TSE poškozený nebo vypršela platnost certifikátu). |
|
POST
/api/v1/management/germany/ {clientId}/tse/selftest |
R |
Spustí synchronní autotest pro danou pokladnu na TSE (pokladna je volitelná). |
|
POST
/api/v1/management/germany/ {clientId}/tse/updateFirmware |
R |
Aktualizuje firmware na hardwarovém zařízení TSE od společnosti swissbit. |
ManagementController_Spain
Stručný popis: Správní funkce pro španělskou fiskalizaci.
| Koncový bod | Typ | Popis |
|
GET
/api/v1/management/spain/ {clientId}/ticketBai |
R |
Vrátí uložené soubory ticketBai (odeslané soubory, soubory s odpověďmi, soubory s chybami) jako soubor ZIP. |
|
GET
/api/v1/management/spain/ {clientId}/ticketBai/{documentNumber} |
R |
Vrátí uložené soubory ticketBai pro požadované číslo dokumentu (odeslané soubory, soubory s odpověďmi, soubory s chybami) jako soubor ZIP. |
Potvrzení
Stručný popis: slouží k odesílání digitálních potvrzení do Cloudu RetailForce prostřednictvím middlewaru.
Koncové body v této sekci slouží k odesílání digitálních dokladů o platbě do Cloud systému (k využívání této služby jsou nutné licence pro digitální doklady o platbě!).
| Koncový bod | Typ | Popis |
| POST /api/v1/receipts/{clientId} | O/M |
Nahraje soubor s digitálními účtenkami do Cloud systému. Alternativa: K odeslání dat digitálních účtenek použijte buď tento, nebo alternativní koncový bod uvedený v této části. |
|
POST
/api/v1/receipts/ {clientId}/{documentGuid} |
O/M |
Nahraje digitální soubor do Cloud systému. Používá Metadata fiskalizace. Alternativa: K odeslání dat digitálních účtenek použijte buď tento, nebo alternativní koncový bod v této části. |
Transakce
Stručný popis: slouží k odesílání dokumentů do middlewaru v rámci fiskalizace.
| Koncový bod | Typ | Popis |
| PUT /api/v1/transactions/createDocument | M |
Vytvoří dokument v jednotce fiskalizace. Tato metoda sama o sobě dokument nevytvoří, pouze spustí proces, například na TSE. |
| POST /api/v1/transactions/storeDocument | M |
Uloží dokument do fiskalizační jednotky. |
| POST /api/v1/transactions/cancelDocument | M |
Zruší dokument v fiskalizační jednotce. |
|
PUT
/api/v1/transactions/reprintDocument/ {clientId}/{documentGuid} |
M* |
Metoda pro uložení počtu opětovných tisků dokumentu s využitím uloženého dokumentu (odkaz: documentGuid). Alternativa: lze také použít PUT /api/v1/transactions/reprintDocument |
|
PUT
/api/v1/transactions/ reprintDocument |
M* |
Metoda pro uložení počtu dotisků dokumentu prostřednictvím opětovného odeslání dokumentu. Uživatelem přeneseného dokumentu musí být uživatel provádějící dotisk (nikoli uživatel původního dokumentu). Alternativa: lze také použít PUT /api/v1/transactions/reprintDocument/ |
|
POST
/api/v1/transactions/ revertDocument |
R |
Vrátí dokument do původního stavu (všechny hodnoty se změní na záporné). |
|
POST
/api/v1/transactions/ validateDocument |
O |
Ověří dokument a vrátí všechny chyby ověření (a prázdný seznam, pokud se nevyskytla žádná chyba ověření). |
|
POST
/api/v1/transactions/ validateDocumentString |
O |
Odešle dokument ve formátu JSON do služby za účelem ověření dokumentu. |
|
GET /api/v1/transactions/document/ {clientId}/start |
R |
Vrátí počáteční dokument pro daného klienta. Počáteční dokument se používá k inicializaci klienta i fiskální jednotky (/api/v1/management/clients/initialize). |
| POST /api/v1/transactions/display/{clientId} | M* |
Zobrazí text na displeji daňového zákazníka. Podporováno pouze v zemích, které používají fiskální zákaznický displej. V ostatních zemích toto volání neprovádí žádnou akci (lze jej však vyvolat). |
|
PUT
/api/v1/transactions/printer/ {clientId}/openDrawer |
M* |
Otevře zásuvku, pokud je k fiskální tiskárně připojena. |
| GET /api/v1/transactions/getQrCodeBase64 | O |
Vrátí data QR kódu jako řetězec zakódovaný v base64 z daných dat. |
| POST /api/v1/transactions/auditlog | M* |
Přidá záznam do auditního protokolu k danému fiskálnímu klientovi. |
| GET /api/v1/transactions/auditlog/{clientId} | M* |
Vrátí všechny záznamy auditu vyžádané pomocí fromDate/tillDate. |
|
GET
/api/v1/transactions/document/ {clientId}/{documentGuid} |
R |
Vrátí požadovaný dokument, pokud je uložen ve vnitřním úložišti. |
|
HEAD
/api/v1/transactions/document/ {clientId}/{documentGuid} |
O |
Vrátí, zda požadovaný dokument existuje ve vnitřním úložišti dokumentů. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{documentId} |
O |
Vrátí požadovaný dokument, pokud je uložen ve vnitřním úložišti. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{documentId} |
O |
Vrátí, zda požadovaný dokument existuje ve vnitřním úložišti dokumentů. |
|
GET
/api/v1/transactions/document/ {clientId}/last |
O |
Vrátí poslední uložený dokument z úložiště dokumentů. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr} |
O |
Vrátí požadovaný dokument, pokud je uložen ve vnitřním úložišti. |
|
GET
/api/v1/transactions/document/ {clientId}/{documentGuid}/response |
R |
Vrátí požadovanou odpověď na dokument, pokud je uložen ve vnitřním úložišti. |
|
GET
/api/v1/transactions/document/ {clientId}/id/{documentId}/response |
O |
Vrátí požadovanou odpověď k dokumentu, pokud je uložen ve vnitřním úložišti. |
|
GET
/api/v1/transactions/document/ {clientId}/fid/{fiscalDocumentNr}/response |
O |
Vrátí požadovaný dokument, pokud je uložen ve vnitřním úložišti. |
Tento článek byl přeložen automaticky.
Komentáře
0 komentářů
Prosím přihlaste se, abyste mohli napsat komentář.