Obsahuje API rozhranie systému eKasa PANDORA - konkrétne triedy (štruktúry) zasielaných správ medzi ECM klient a ECM server.
Jednotlivé API štruktúry sa používajú v argumentoch metód triedy ECM_Client.
Classes
Class | Description | |
---|---|---|
FiscalBill | Objekt Pokladničného dokladu - obsahuje hlavičku a položky dokladu, rekapituláciu súm dokladu. | |
FiscalCashOperation | Objekt hotovostnej operácie - vklad a výber. | |
FiscalLocation | Trieda umiestnenia mobilnej pokladnice (adresa, GPS súradnice). | |
MsgECM_Balance_Req | Parameter požiadavky na vytlačenie uzávierky, napr. dennej, prehľadovej a podobne. | |
MsgECM_Balance_Rsp | Odpoveď na požiadavku na vytlačenie uzávierky, napr. dennej, prehľadovej a podobne. | |
MsgECM_CashDrawerOpen_Req |
Požiadavka na otvorenie pokladničnej zásuvky. Predpokladá sa, že zásuvka je pripojená na tlačiareň dokladov.
| |
MsgECM_CashDrawerOpen_Rsp | Odpoveď na otvorenie pokladničnej zásuvky. | |
MsgECM_Control_Req | Požiadavka na ovládanie programu ECM, napr. reštart, ukončenie a podobne, prípadne ovládanie fiškálneho zariadenia (CHDÚ), napr. reštart. | |
MsgECM_Control_Rsp | Odpoveď na požiadavku ovládať ECM alebo zariadenie (CHDÚ). | |
MsgECM_DeviceConnect_Req | Požiadavka na ECM server o vynútené otvorenie komunikácie (refresh) s fiškálnym zariadením alebo CHDÚ.
Metódu nie je potrebné volať, pretože server ECM má trvale vytvorenú komunikáciu so zariadením - v odôvodnených prípadoch
sa však môže vynútiť pokus o pripojenie k zariadeniu. | |
MsgECM_DeviceConnect_Rsp | Odpoveď na požiadavku na ECM server o vynútené otvorenie komunikácie s fiškálnym zariadením alebo CHDÚ. | |
MsgECM_DeviceDisconnect_Req | Požiadavka na ECM server o zatvorenie komunikácie s fiškálnym zariadením alebo CHDÚ. | |
MsgECM_DeviceDisconnect_Rsp | Odpoveď na požiadavku na ECM server o zatvorenie komunikácie s fiškálnym zariadením alebo CHDÚ. | |
MsgECM_DeviceInfo_Req | Požiadavka na načítanie informácií o eKasa zariadení. | |
MsgECM_DeviceInfo_Rsp | Informácia o eKasa zariadení. | |
MsgECM_FindDeviceInfo | Odpoveď na broadcast po žiadosti o základné údaje. | |
MsgECM_FindDevices_Req | Požiadavka na načítanie údajov všetkých zariadení, ktoré odpovedajú na broadcast. | |
MsgECM_FindDevices_Rsp | Odpoveď na vyhľadanie zariadení pripojené k počítaču (v lokálnej sieti). | |
MsgECM_FiscalBillRegister_Req | Parameter požiadavky na zaevidovanie pokladničného dokladu Pokladničná účtenka - obsahuje hlavičku a položky dokladu, rekapituláciu súm dokladu. | |
MsgECM_FiscalBillRegister_Rsp | Odpoveď pri zaevidovaní dokladu - obsahuje návratové hodnoty, napr. číslo dokladu, OKP, a podobne. | |
MsgECM_FiscalCashOperation_Req | Požiadavka na vykonanie hotovostnej operácie vkladu, výberu. | |
MsgECM_FiscalCashOperation_Rsp | Odpoveď na požiadavku hotovostnej operácie, napr. vkladu, výberu. | |
MsgECM_GetAuthData_Req | Požiadavka na načítanie identifikačných údajov z CHDU. | |
MsgECM_GetAuthData_Rsp | Odpoveď na načítanie autentifikačných údajov z CHDU. | |
MsgECM_GetECMCommunication_Req | Umožňuje načítať nastavenie komunikácie medzi programom EXALOGIC CashRegister Manager a fiškálnym zariadením (požiadavka). | |
MsgECM_GetECMCommunication_Rsp | Umožňuje načítať nastavenie komunikácie medzi programom EXALOGIC CashRegister Manager a fiškálnym zariadením (odpoveď). | |
MsgECM_GetFiscalDeviceCommunication_Req | Umožňuje načítať nastavenie parametrov fiškálneho zariadenia (tak ako je fiškálne zariadenie nastavené (požiadavka). | |
MsgECM_GetFiscalDeviceCommunication_Rsp | Umožňuje načítať nastavenie parametrov fiškálneho zariadenia (tak ako je fiškálne zariadenie nastavené (odpoveď). | |
MsgECM_GetIdentityData_Req | Požiadavka na načítanie identifikačných údajov (IČO, DIČ, Názov, Adresa, ...) z fiškálneho zariadenia. | |
MsgECM_GetIdentityData_Rsp | Odpoveď na načítanie identifikačných údajov (IČO, DIČ, Názov, Adresa, ...) z fiškálneho zariadenia. | |
MsgECM_GetJournal_Req | Požiadavka na načítanie žurnálu z fiškálneho zariadenia (z dátovej časti WORM). | |
MsgECM_GetJournal_Rsp | Odpoveď na načítanie žurnálu z fiškálneho zariadenia (z CHDÚ). | |
MsgECM_GetLocation_Req | Požiadavka na načítanie polohy pokladnice (adresy alebo GPS súradnice) z fiškálneho zariadenia. | |
MsgECM_GetLocation_Rsp | Odpoveď na požiadavku o vrátenie polohy pokladnice (adresy alebo GPS súradnice) z fiškálneho zariadenia. | |
MsgECM_GetLogs_Req | Požiadavka na vyčítanie logov z CHDU. | |
MsgECM_GetSettings_Req | Požiadavka na načítanie nastavení z fiškálneho zariadenia (CHDÚ). Požiadavka môže obsahovať jedno, prípadne
viac nastavení - jedným volaním je možné načítať ľubovoľný počet nastavení. | |
MsgECM_GetSettings_Rsp | Odpoveď na načítanie nastavení z fiškálneho zariadenia (CHDÚ). Obsahuje hodnoty,
ktoré boli uvedené v požiadavke. | |
MsgECM_GetUnsentDocuments_Req | Požiadavka na vrátenie (načítanie) neodoslaných dátových správ z CHDÚ.
Vracajú sa správy rôzneho typu, napr. pokladničné doklady, výbery a vklady a podobne. | |
MsgECM_GetUnsentDocuments_Rsp | Odpoveď na vrátenie (načítanie) neodoslaných dátových správ z CHDÚ.,
Vracajú sa správy rôzneho typu, napr. pokladničné doklady, výbery a vklady a podobne. | |
MsgECM_Numbers_Req | Parameter požiadavky na vrátenie čísiel dokladov. | |
MsgECM_Numbers_Rsp | Odpoveď na požiadavku - vracia čísla aktuálnych dokladov uložených vo fiškálnom zariadení. | |
MsgECM_PrintDocumentCopy_Req | Požiadavka na vytlačenie kópie dokladu. Najčastejšie ide o kópiu pokladničného dokladu,
prípadne výberu alebo vkladu hotovosti. | |
MsgECM_PrintDocumentCopy_Rsp | Odpoveď na požiadavku pre vytlačenie kópie dokladu. Môže ísť o pokladničný doklad, výber alebo vklad. | |
MsgECM_PrintText_Req | Požiadavka na vytlačenie ľubovoľného (nefiškálneho) textu. Pri tlači sa na Finančnú správu nezasiela žiadna dátová správa,
vytlačený text (tlačová úloha) sa zapisuje do CHDÚ. | |
MsgECM_PrintText_Rsp | Odpoveď na vytlačenie ľubovoľného (nefiškálneho) textu. Pri tlači sa na Finančnú správu nezasiela žiadna dátová správa,
vytlačený text (tlačová úloha) sa zapisuje do CHDÚ. | |
MsgECM_PrintUnsentDocuments_Req | Požiadavka na vytlačenie neodoslaných dátových správ. Tlačia sa v poradí, v akom boli dátové správy zaevidované v CHDÚ,
pričom môžu byť rôzneho typu, napr. pokladničné doklady, výbery a vklady a podobne. | |
MsgECM_PrintUnsentDocuments_Rsp | Odpoveď na vytlačenie neodoslaných dátových správ. Tlačia sa v poradí, v akom boli dátové správy zaevidované v CHDÚ,
pričom môžu byť rôzneho typu, napr. pokladničné doklady, výbery a vklady a podobne. | |
MsgECM_Req | Základná trieda pre správy "požiadavky" (pakety) komunikácie medzi serverom a klientom. | |
MsgECM_Rsp | Základná trieda pre správy "odpovede" (pakety) komunikácie medzi serverom a klientom. | |
MsgECM_SendUnsentDocuments_Req | Požiadavka na zaslanie všetkých neodoslaných dátových správ z CHDÚ na Finančnú správu, napr. pokladničných dokladov, výberov a vkladov a podobne. | |
MsgECM_SendUnsentDocuments_Rsp | Odpoveď na zaslanie všetkých neodoslaných dátových správ z CHDÚ na Finančnú správu, napr. pokladničných dokladov, výberov a vkladov a podobne. | |
MsgECM_SetAuthData_Req | Požiadavka na uloženie autentifikačných údajov (certifikátu) do CHDU. | |
MsgECM_SetAuthData_Rsp | Odpoveď na uloženie autentifikačných údajov (certifikátu) do CHDU. | |
MsgECM_SetECMCommunication_Req | Umožňuje nastaviť (zapísať) nastavenie komunikácie medzi programom EXALOGIC CashRegister Manager a fiškálnym zariadením (požiadavka). | |
MsgECM_SetECMCommunication_Rsp | Umožňuje načítať nastavenie komunikácie medzi programom EXALOGIC CashRegister Manager a fiškálnym zariadením (odpoveď). | |
MsgECM_SetFiscalDeviceCommunication_Req | Umožňuje nastaviť (zapísať) parametre komunikácie priamo do fiškálneho zariadenia (požiadavka). | |
MsgECM_SetFiscalDeviceCommunication_Rsp | Umožňuje nastaviť (zapísať) parametre komunikácie priamo do fiškálneho zariadenia (odpoveď). | |
MsgECM_SetIdentityData_Req | Požiadavka na uloženie identifikačných údajov (IČO, DIČ, Názov, Adresa, ...) do fiškálneho zariadenia. | |
MsgECM_SetIdentityData_Rsp | Odpoveď na uloženie identifikačných údajov (IČO, DIČ, Názov, Adresa, ...) do fiškálneho zariadenia. | |
MsgECM_SetLocation_Req | Požiadavka na uloženie polohy pokladnice (adresy alebo GPS súradnice) do fiškálneho zariadenia (v prípade on-line zároveň aj FS). | |
MsgECM_SetLocation_Rsp | Odpoveď na uloženie polohy pokladnice (adresy alebo GPS súradnice) do fiškálneho zariadenia (v prípade on-line zároveň aj FS). | |
MsgECM_SetSettings_Req | Požiadavka na zápis nastavení do fiškálneho zariadenia (CHDÚ). Požiadavka môže obsahovať jedno, prípadne
viac nastavení - jedným volaním je ich možné zapísať ľubovolný počet. | |
MsgECM_SetSettings_Rsp | Odpoveď na zápis nastavení do fiškálneho zariadenia (CHDÚ). V prípade súčasného zápisu viacerých nastavení,
ak dôjde pri kontrole hodnôt (validácii) k chybe, nebude zapísaná žiadna hodnota. | |
MsgECM_StatusInfo_Req | Požiadavka na načítanie stavu eKasa systému, napr. či je zariadenie zapnuté, či je komunikácia s Finančnou správou a podobne. | |
MsgECM_StatusInfo_Rsp | Odpoveď na načítanie stavu eKasa systému, napr. či je zariadenie zapnuté, či je komunikácia s Finančnou správou a podobne. | |
MsgECM_Support_Req | Požiadavka na načítanie informácií o možnostiach (podpore) zariadenia rôznych funkcií, napr. či podporuje intervalovú uzávierku v rozsahu zadania času a nielen dátumu a podobne (požiadavka). | |
MsgECM_Support_Rsp | Odpoveď na načítanie informácií o možnostiach (podpore) fiškálneho zariadenia rôznych funkcií, napr. či podporuje intervalovú uzávierku v rozsahu zadania času a nielen dátumu a podobne (odpoveď). | |
MsgECM_UpdateState_Rsp | Odpoveď na načítanie stavu eKasa systému, napr. či je zariadenie zapnuté, či je komunikácia s Finančnou správou a podobne. |
Structures
Structure | Description | |
---|---|---|
FiscalBillFiscalBillItem | Položka pokladničného dokladu - štruktúra obsahuje údaje o jednej položke pokladničného dokladu. | |
FiscalBillFiscalBillPaymentType | Typ platidla - štruktúra obsahuje údaje o type platby k pokladničnému dokladu. | |
FiscalBillFiscalBillPriceValues | Rekapitulácia súm dokladu - štruktúra obsahuje celkovú sumu dokladu a rekapituláciu súm dokladu. |
Enumerations
Enumeration | Description | |
---|---|---|
enm_BalanceType |
Typ uzávierky, ktorý sa má vykonať, napr. denná, prehľadová, intervalová ...
| |
enm_ControlCommand | Príkaz na ovládanie ECM alebo fiškálneho zariadenia (CHDÚ), napr. reštart, ukončenie (vypnutie) a podobne. | |
enm_ECM_SettingsNumber |
Zoznam nastavení fiškálneho zariadenia (CHDÚ).
| |
enm_FiscalDeviceModel | Model (typ) zariadenia, s ktorým komunikuje ECM server. Môže to byť zariadenie EXALOGIC (eKasa PANDORA),
prípadne iného výrobcu, napr. ELCOM EFOX, A3 Soft a podobne. Upozornenie! v OBERON-e je tento istý ENUM, v prípade úpravy potrebné upraviť. | |
enm_GetJournalDataTypes | Typ údajov (súborov), ktoré majú byť vrátené pri načítaní žurnálu (dátových správ) z CHDÚ. | |
enm_CHDUState | Stav chráneného dátového úložiska, napr. chyba, málo voľnej pamäte a podobne. | |
enm_MsgType | Určuje typ správy - komunikácia medzi serverom a klientom. | |
enm_PrintDocumentCopyType |
Určuje typ dokladu (tlačovej úlohy), ktorého kópia sa má vytlačiť. Môže ísť o pokladničný doklad, prípadne výber alebo vklad hotovosti.
| |
enm_Result | Výsledok operácie - 0-OK, záporné číslo - chyba, kladné číslo - varovanie | |
enm_UpdateState | Zmena stavu servera PPEKK. Zasiela sa klientom PPEKK (servera) ako správa o nejakej zmene v PPEKK. Ide o špeciálnu správu, ktorá nemá Req,
používa sa napr. ako CallBack, napr. pri aktualizácii firmware, prípadne ako správa pre všetkých klientov servera. | |
FiscalBillenm_CustomerIDType | Druhy použiteľných identifikátorov klienta. | |
FiscalBillenm_ItemRegisterFlag | Typ položky pokladničného dokladu - určuje spôsob zaevidovania položky do fiškálneho zariadenia, najmä typ zápornej položky. | |
FiscalBillenm_SellerIdType | Predstavuje identifikátora osoby, v ktorej mene bol predaný tovar alebo poskytnutá služba (údaj sa posiela na Finančnú správu), napr. DIČ, IČ DPH. | |
FiscalBillenm_SpecialRegulation |
Nepovinný atribút "SpecialRegulation" predstavuje príznak, ktorý bližšie špecifikuje „dôvod“ priradenia dane s hodnotou 0,
ak bola položke priradená. ORP musí pre takéto položky umožňovať priradenie a zaslanie presných slovných informácií do systému e-kasa.
| |
FiscalBillenum_PaymentTypeBase | Typ platby v pokladnici, napr. daňový doklad, vnútorné zúčtovanie, presun na hotelový účet. | |
FiscalCashOperationenm_OperationType | Druh operácie hotovosti. | |
MsgECM_FiscalBillRegister_Reqenm_ReceiptCreateMode | Spôsob vyhotovenia (zaevidovania) pokladničného dokladu. Najčastejšie ide o tlač dokladu, môže sa však aj zaslať e-mailom. | |
MsgECM_Support_Rspenm_Communication | Obsahuje zoznam spôsobov komunikácie daného fiškálneho zariadenia. |