Skip to content

Data model

yurislav edited this page Jul 20, 2022 · 9 revisions

Dátový model

  1. Požiadavka na registráciu dokladu
  2. Doklad
    1. Typy dokladov
    2. Vlastnosti dokladu
  3. Položka dokladu
    1. Typy položky dokladu
    2. Vlastnosti položky dokladu
  4. Množstvo
  5. Predávajúci
  6. Platba dokladu
  7. Informácie o kupujúcom
  8. Spôsob vyhotovenia dokladu
    1. Papierový doklad
    2. Elektronický doklad - PDF súbor
    3. Elektronický doklad - E-mail
  9. Výsledok registrácie dokladu

Požiadavka na registráciu dokladu

Dátový model obsahuje 3 vlastnosti:

Vlastnosť Povinné Význam
request Áno Obsahuje informácie o doklade, ktorý má byť vyhotovený.
printer Nie Určuje spôsob vyhotovenia dokladu (papierový alebo elektronický doklad). Ak nie je uvedené, doklad bude vyhotovený v papierovej forme.
validityTimeSpan Nie Maximálna platnosť požiadavky registrácie dokladu, vyjadrená v milisekundách. Ak počas tohto intervalu nedôjde k akceptácií požiadavky dokladu koncovým zariadením, požiadavka bude zrušená. Ak nie je uvedené, bude použitý predvolený časový interval (5 sekúnd).

Doklad

Dokladom sa rozumie sada informácii, ktoré slúžia na vyhotovenie pokladničného dokladu.

Pri registrácii dokladu sa tieto informácie vkladajú do vlastnosti request.

Podľa prípadu použitia sú v legislatíve definované viaceré typy dokladov.

V závislosti od typu dokladu sa mení aj rozsah vlastnosti, ktoré musí (alebo naopak nemôže) aplikácia tretej strany uviesť pri registrácii príslušného typu dokladu.

Typy dokladov

Systém eKasa Cloud rozlišuje nasledovné typy dokladov:

Názov Identifikátor Prípad použitia
Pokladničný doklad cashRegister Bežný pokladničný doklad, ktorý je vyhotovovaný pri predaji, prípadne pri vráteni tovaru alebo dobropisovaní faktúry.
Neplatný doklad invalid Doklad je vhodné vyhotovovať v tzv. tréningovom režime, napríklad pre zaškolenie obsluhy alebo overenie funkčnosti on-line pokladnice.
Vlastnosťami sa nelíši oproti registrácii bežného pokladničného dokladu. Papierový doklad však v každom treťom riadku obsahuje slová "Neplatný doklad", aby nedošlo k zámene s platným (ostrým) dokladom.
Paragón paragon Dodatočné zaregistrovanie pokladničného dokladu, ktorý bol vyhotovený vo forme paragónu.
Paragón je pokladničný doklad, ktorý bol vyhotovený v čase poruchy registračnej pokladnice. Po odstránení závady pokladnice je obsluha povinná bez zbytočného odkladu dodatočne zaevidovať tržbu.
Faktúra invoice Úhrada faktúry v hotovosti.
Paragón pri úhrade faktúry invoiceParagon Hotovostná úhrada faktúry, pričom príjmový pokladničný doklad bol vyhotovený vo forme paragónu.
Doklad označený slovom „Vklad“ deposit Doklad, ktorý sa vystavuje pri vklade hotovosti do on-line pokladnice, ktorá nebola prijatá na základe vyhotoveného dokladu.
Vklad je nutné zadávať do systému v momente, kedy obsluha vkladá do peňažnej zásuvky (alebo peňaženky) hotovosť, ktorá nie je tržbou - napríklad doplnenie hotovosti určenej na rozmieňanie.
Doklad označený slovom „Výber“ withdraw Doklad, ktorý sa vystavuje pri výbere hotovosti z on-line pokladnice.
Výber je nutné zadávať do systému v momente, kedy obsluha vyberá z peňažnej zásuvky (alebo peňaženky) hotovosť - napríklad pre účely vyplatenia dodaného tovaru, alebo po ukončení predaja (napr. po uzávierke systému).

Poznámka: Znamienko sumy výberu nie je finančnou správou usmernené. Doklad typu výber je tak možné zaregistrovať s kladným aj záporným znamienkom. Doklady typu výber však odporúčame evidovať so záporným znamienkom, nakoľko pri prípadnom exporte údajov z portálu finančnej správy sa v tabuľkovom editore jednoduchšie spočítavajú celkové obraty.

Poznámka 2: Nakoľko systém finančnej správy eKasa pri registrácii dokladu nerozlišuje platidlá, je potrebné pri výbere uvádzať celkovú prijatu tržbu v hotovosti, teda aj sumu prijatú prostredníctvom platobného terminálu.

Vlastnosti dokladu

Identifikátor Popis Dátový typ Poznámka
receiptType Typ dokladu. string Povinný parameter, ktorý nadobúda jednu z hodnôt uvedených v tabuľke Typy dokladov.
cashRegisterCode Číslo registračnej pokladnice. string Povinný parameter. Určuje, na ktorom koncovom zariadení má byť doklad vyhotovený.
externalId Externý identifikátor dokladu. string Ide o unikátny identifikátor generovaný aplikáciou tretej strany, slúži ako mechanizmus ochrany proti duplicitnému zaevidovaniu dokladu.

Ak je v systéme eKasa Cloud už nájdený doklad s rovnakým externalId, systém eKasa Cloud:
- vráti výsledok pôvodnej registrácie dokladu (nevzniká tak duplicitná tržba), ak ide o registráciu identického dokladu (teda práve registrovaný doklad sa presne zhoduje s nájdeným dokladom naprieč všetkými vlastnosťami).
- vráti chybovú odpoveď, ak ide o registráciu dokladu, ktorý sa odlišuje od nájdeného, už zaregistrovaného dokladu.
headerText Vlastný text v záhlaví dokladu. string
footerText Vlastný text v päte dokladu. string
customer Informácie o kupujúcom. customer Voliteľná hodnota. Nie je možné uviesť pri doklade typu neplatný doklad (invalid).
issueDate Dátum a čas vyhotovenia paragónu. date
paragonNumber Poradové číslo paragónu number
invoiceNumber Číslo faktúry string
amount Celková suma dokladu number Vyjadrená s DPH. Vlastnosť je možné uviesť iba pri dokladoch typu faktúra (invoice), vklad (deposit) alebo výber (withdraw).
roundingAmount Výška zaokrúhlenia number Povolený rozsah od -0.04 do 0.04. Vlastnosť nie je možné pri dokladoch typu vklad (deposit) a výber (withdraw).
items Položky dokladu receiptItem[] Zoznam položiek dokladu. Vlastnosť je možné uviesť iba pri dokladoch typu pokladničný doklad (cashRegister), neplatný doklad (invalid) alebo paragón (paragon).
payments Platby dokladu receiptPayment[] Nepovinný zoznam platieb dokladu, ktorými kupujúci uhradil doklad.

Poznámka: Ide o nepovinné pole dokladu, ktoré aplikácia tretej strany nemusí vypĺňať - na servery finančnej správy nie sú odoslané. V prípade, ak ale aplikácia tretej strany platby uvedie, je potrebné, aby sa ich celková suma rovnala, alebo prevyšovala celkovú sumu dokladu, ktorá je daná súčtom cien položiek dokladu (item.price).

Poznámka 2: Počet platieb nachádzajúcich sa v zozname platieb dokladu je limitovaný na 50.

Nasledovná tabuľka popisuje vzťah medzi vlastnosťou a typom dokladu.

Význam symbolov použitých v tabuľke:

Symbol Význam Popis
R Required Povinné pole.
O Optional Nepovinné pole.
(bez symbolu) Forbidden Zakázané pole. Nesmie v požiadavke nadobúdať hodnotu (inú, ako null).
Vlastnosť / Typ cashRegister invalid paragon invoice invoiceParagon deposit withdraw
receiptType R R R R R R R
cashRegisterCode R R R R R R R
externalId R R R R R R R
headerText O O O O O O O
footerText O O O O O O O
customer O O O O O O
issueDate R R
paragonNumber R R
invoiceNumber R R
amount R R R R
roundingAmount O O O O O
items R R R
payments O O O

Položka dokladu (receiptItem)

Typy položky dokladu

Každá položka dokladu môže nadobúdať niektorý z nižšie uvedených typov:

Identifikátor Názov Typ položky Popis
positive Kladná položka Kladná Predaj tovaru alebo poskytnutie služby
returnedContainer Vrátené obaly Záporná Vykúpené zálohované obaly.
returned Vrátená Záporná Zrušenie evidovanej položky po jej vystavení na pokladničnom doklade pri vrátení tovaru alebo služby. Napríklad pri reklamácii.
correction Opravná Kladná alebo záporná Negácia položky už zaevidovaného dokladu v systéme e-kasa v prípade jej opravy. Napríklad pri omyle obsluhy.
discount Zľava Záporná Poskytnutá zľava
advance Odpočítaná záloha Záporná Suma prijatého preddavku uvedená na doklade vystavenom v čase úhrady doplatku ceny za predaný tovar alebo poskytnutú službu. Používa sa, ak bola za tovar už v minulosti obdržaná záloha.
voucher Výmena poukazu Záporná Suma jednoúčelového poukazu pri jeho výmene za tovar alebo poskytnutú službu. Používa sa pri samotnom uplatnení vopred zakúpeného poukazu.

Vlastnosti položky dokladu

Položka dokladu má nasledovné vlastnosti:

Identifikátor Popis Dátový typ Poznámka
type Typ položky. string Povinný parameter, ktorý nadobúda jednu z hodnôt uvedených v tabuľke Typy položky dokladu.
name Označenie tovaru alebo služby. string Povinný parameter. Neprázdny textový reťazec maximálnou dĺžkou 255 znakov.

Poznámka: Niektoré symboly (najmä netlačiteľné) sú sytémom eKasa zakázané.
price Celková cena tovaru alebo služby. number Povinný parameter. Hodnota v rozsahu -1000000010000000, s presnosťou na dve desatinné miesta. Vyjadrená vrátane DPH.

Poznámka: Celková cena musí byť rovná súčinu jednotkovej ceny a množstva, teda: unitPrice * quantity = price.
unitPrice Jednotková cena tovaru alebo služby number Povinný parameter. Jednotková cena tovaru alebo služby v EUR v rozsahu -1000000010000000 s presnosťou na šesť desatinných miest.

Poznámka: Povolený rozsah je daný typom položky.
Položka kladného typu (typ positive), musí mať kladnú jednotkovú cenu v rozsahu 010000000.
Položky záporného typu (typy returnedContainer, returned, discount, advance a voucher) musia mať zápornú jednotkovú cenu v rozsahu -100000000.
Položka opravného typu (typ correction) môže nadobúdať kladné aj záporné hodnoty v rozsahu -1000000010000000.
quantity Množstvo tovaru alebo rozsah služby quantity Povinný parameter. Popis objektu typu quantity nájdete nižšie.
vatRate Sadzba dane z pridanej hodnoty. number Povinný parameter. Sadzba dane s presnosťou na 2 desatinné miesta. Musí nadobúdať jednu z hodnôt: 20, 10 alebo 0.
specialRegulation Dôvod priradenia sadzby dane s hodnotou 0. string Príznak, ktorý bližšie špecifikuje „dôvod“ priradenia dane s hodnotou 0, ak takáto bola položke priradená. Ide o nepovinný atribút, ktorý je nepovinný aj pre položky s 0% sadzbou dane. Hodnota musí byť uvedená iba pre tie položky s nulovou sadzbou dane, ktoré reprezentujú niektorú z nižšie uvedených možností: prenesenie daňovej povinnosti (VATReverseCharge), oslobodenie položky od dane (VATExemptionGood), osobitná úprava uplatňovania dane pri cestovných kanceláriách (TravelAgency), osobitná úprava uplatňovania dane pri použitom tovare (UsedGood), osobitná úprava uplatňovania dane pri umeleckých dielach (Artwork), alebo osobitná úprava uplatňovania dane pri zberateľských predmetoch a starožitnostiach (CollectiblesAndAntiques).
seller Predávajúci seller Nepovinný parameter. Uvádza sa iba v prípade, ak predávajúci, v ktorého mene bol predaný tovar alebo poskytnutá služba je iný, ako podnikateľský subjekt priradený k on-line registračnej pokladnici.
description Doplňujúci popis položky string Nepovinný dodatočný popis položky dokladu, vyobrazený na doklade. Slúži pre umiestnenie informácie o dátume spotreby, sériovom čísle výrobku a podobne. Tlačí sa hneď za názvom produktu a informáciami o množstve a cenách. Tento textový reťazec nie je odosielaný do finančnú správu, systému eKasa. Tento parameter podporuje použitie tzv. token-ov pre formátovanie, tlač QR kódov a čiarových kódov.
referenceReceiptId Identifikátor pôvodného dokladu string Slúži ako referencia na iný (pôvodný) doklad. Túto vlastnosť je možné uviesť iba v prípade, ak typ položky je correction alebo returned. V opačnom prípade musí vlastnosť nadobúdať hodnotu null (teda nesmie byť uvedená).

Poznámka: V prípade, ak pôvodný doklad obsahuje unikátny identifikátor dokladu (bol zaregistrovaný v online režime), ako referenčné číslo dokladu sa uvedie tento identifikátor (vlastnosť response.id).
V prípade, ak pôvodný doklad neobsahuje unikátny identifikátor dokladu (bol zaregistrovaný v offline režime), ako referenčné číslo dokladu sa uvedie OKP (vlastnosť request.okp).
voucherNumber Číslo jednoúčelového poukazu string Číslo jednoúčelového poukazu pri jeho výmene za tovar alebo poskytnutú službu. Hodnota môže byť uvedená iba pre položky s typom voucher a musí obsahovať textový reťazec s dĺžkou 150 znakov. Pre položky iného typu musí byť hodnota rovná null.

Nasledovná tabuľka popisuje vzťah medzi vlastnosťou a typom dokladu.

Význam symbolov použitých v tabuľke:

Symbol Význam Popis
R Required Povinné pole.
O Optional Nepovinné pole.
(bez symbolu) Forbidden Zakázané pole. Nesmie v požiadavke nadobúdať hodnotu (inú, ako null).
Vlastnosť / Typ positive returnedContainer returned correction discount advance voucher
type R R R R R R R
name R R R R R R R
price R R R R R R R
unitPrice R R R R R R R
quantity R R R R R R R
vatRate R R R R R R R
specialRegulation O O O O O O O
seller O O O O O O O
description O O O O O O O
referenceReceiptId R R
voucherNumber R

Množstvo (quantity)

Objekt popisujúci množstvo obsahuje dve vlastnosti: amount a unit.

Názov Povinné pole Popis
amount Áno Hodnota v rozsahu 010000000 s presnosťou na štyri desatinné miesta.
unit Nie Nepovinná množstevná jednotka s dĺžkou 13 znaky. Ak nie je uvedená, predvolená hodnota je x.

Predávajúci (seller)

Obsahuje predávajúceho obsahuje dve vlastnosti: id a type.

Názov Povinné pole Popis
id Áno Identifikátor predávajúceho, v ktorého mene bol predaný tovar alebo poskytnutá služba.
type Áno Typ identifikátora predávajúceho, v ktorého mene bol predaný tovar alebo poskytnutá služba. Povolené hodnoty sú v tabuľke nižšie.

Povolené hodnoty vlastnosti type:

Hodnota type Popis Formát hodnoty id
DIC DIČ ^[0-9]{8,10}$ - 8 až 10 číselných znakov.
ICDPH IČ DPH ^SK[0-9]{8,10}$ - písmena SK následované 8 až 10 číselnými znakmi.

Platba dokladu (receiptPayment)

Každá platba dokladu pozostáva z dvojice vlastností amount a name.

Názov Povinné pole Popis
amount Áno Peňažný obnos platby s presnosťou na 2 desatinné miesta.
name Áno Názov (slovný popis) platidla s dĺžkou v rozmedzí 1255 znakov.

Informácie o kupujúcom (customer)

Informácie o kupujúcom je možné uviesť pri registrácii dokladu vo vlastnosti customer aj e reprezentovaná objektom customerInfo, ktorý obsahuje tieto vlastnosti:

Názov Povinné pole Popis
id Áno Identifikátor kupjúceho.
type Áno Typ identifikátora kupjúceho. Povolené hodnoty sú v tabuľke nižšie.

Povolené hodnoty vlastnosti type:

Hodnota type Popis Formát hodnoty id
DIC DIČ ^[0-9]{10}$ - 10 číselných znakov.
ICDPH IČ DPH ^SK[0-9]{8,10}$ - písmena SK následované 8 až 10 číselnými znakmi.
ICO IČO ^[0-9]{6}$ alebo ^(?:[0-9]{8}|[0-9]{12})$ - 6, 8 alebo 12 číselných znakov. V prípade skráteného 6-miestneho formátu budú automaticky doplnené dve nuly pre docielenie 8-miestneho formátu.
Other Iný typ identifikátora kupujúceho

Spôsob vyhotovenia dokladu

Aplikácia tretej strany má pri registrácii dokladu možnosť uviesť spôsob, akým bude doklad vyhotovený, uvedením vlastnosti printer.

Určenie spôsobu vyhotovenia však nie je zákonom dovolené pri všetkých typoch dokladov, túto skutočnosť popisuje tabuľka nižšie.

Typ dokladu Identifikátor typu dokladu možnosť určiť spôsob vyhotovenia
Pokladničný doklad cashRegister Áno
Neplatný doklad invalid Áno
Paragón paragon Nie
Faktúra invoice Áno
Paragón pri úhrade faktúry invoiceParagon Nie
Doklad označený slovom „Vklad“ deposit Nie
Doklad označený slovom „Výber“ withdraw Nie

Spôsob vyhotovenia je možné úrčiť pomocou vlastnosti print.printerName.

Podporované sú celkom tri spôsoby vyhotovenia dokladu:

  1. pos - papierový doklad (predvolený spôsob vyhotovenia dokladu)
  2. pdf - elektronický doklad - PDF súbor
  3. email - elektronický doklad - email s PDF súborom v prílohe

Ak nie je vlastnosť printer špecifikovaná, použije sa predvolený spôsob vyhotovenia dokladu - papierový doklad (pos).

Poznámka: Ak je doklad zaevidovaný v offline režime (v čase registrácie nemala pokladnica spojenie s eKasa serverom finančnej správy), v zmysle pokynov finančnej správy musí pokladnica vyhotoviť doklad v papierovej podobe. A to bez ohladu na to, či bolo aplikáciou tretej strany vyžiadané vyhotovenie dokladu elektronickou formou.

Objekt printer obsahuje dve vlastnosti:

  • printerName: spôsob vyhotovenia dokladu (hodnota pos, pdf alebo email).
  • options: povinné aj voliteľné prepínače ovplyvňujúce vyhotovenie dokladu.

Papierový doklad

Pre vyhotovenie dokladu vo forme papierového účtu je potrebné zašpecifikovať v poli printer.name hodnotu pos, alebo neuviesť pole printer vôbec.

V objekte options je možné uviesť nasledovné hodnoty:

Názov Povinné pole Popis
OpenDrawer Nie Umožňuje určiť, či sa pre tento konkrétny doklad otvorí (hodnota true), prípadne neotvorí (hodnota false) peňažná zásuvka. Toto nastavenie umožňuje nadradenej aplikácii variabilne určovať, pri ktorých typoch dokladov, prípadne pri ktorých platidlách je vhodné otvárať peňažnú zásuvku. Ak je toto nastavenie uvedené, získava prioritu nad nastavením uvedeným v konfigurácií aplikácie.
PrintLogo Nie Umožňuje určiť, či sa pre tento doklad vytlačí (hodnota true), prípadne nevytlačí (hodnota false) grafické logo. Ak je toto nastavenie uvedené, získava prioritu nad nastavením uvedeným v konfigurácií aplikácie.
LogoMemoryAddress Nie Umožňuje určiť, aké logo sa pre tento doklad vytlačí. Ak je toto nastavenie uvedené, získava prioritu nad nastavením uvedeným v konfigurácií aplikácie.

Elektronický doklad - PDF súbor

Pre vyhotovenie dokladu vo forme PDF súboru je potrebné zašpecifikovať v poli printer.name hodnotu pdf. Tento spôsob vyhotovenia neposkytuje žiadne dodatočné nastavenia v poli options.

PDF súbory koncové zariadenie uchováva na svojom lokálnom disku. PDF súbor v tomto režime nie je ďalej spracúvaný (teda ani posielaný do emailového klienta).

Elektronický doklad - E-mail

Pre vyhotovenie dokladu vo forme emailu je potrebné zašpecifikovať v poli printer.name hodnotu email.

V objekte options je možné uviesť nasledovné hodnoty:

Názov Povinné pole Popis
To Áno E-mailová adresa adresáta (e-mail, na ktorý má byť doklad odoslaný)
Subject Nie Umožňuje určiť predmet e-mailu, ktorý sa použije pre tento konkrétny doklad. Ak je toto nastavenie uvedené, získava prioritu nad nastavením uvedeným v konfigurácii kocového zariadenia.
Body Nie Umožňuje určiť telo e-mailu, ktorý sa použije pre tento konkrétny doklad. Ak je toto nastavenie uvedené, získava prioritu nad nastavením uvedeným v konfigurácii kocového zariadenia.
RecipientDisplayName Nie Umožňuje určiť zobrazovacie meno adresáta e-mailu.

Poznámka: Možnosť uvedenia viacerých adresátov emailu (napríklad prostredníctvom tzv. carbon copy CC) nie je v súlade s legislatívou, nakoľko zákon nepozná viac ako jeden originál pokladničného dokladu. Každý elektronický doklad je preto možné poslať iba na jednu emailovú adresu.

Správanie koncového zariadenia po zlyhanom odoslaní e-mailu

Ak sa doklad podarí úspešne zaregistrovať na finančnej správe a uložiť všetky potrebné údaje do úložiska a zlyhá až samotné odoslanie e-mailu obsahujúci doklad, túto skutočnosť indikuje aplikácia vrátením chyby z rozsahu -5XX teda kategória označená ako "Chyby tlače". V takomto prípade je príloha e-mailu, teda samotný PDF súbor reprezentujúci e-doklad, uchovaný v rovnakom adresári, aký je použitý pri vyhotovovaní elektronického dokladu v režime PDF súboru (viď sekciu "Elektronický doklad vo forme PDF súboru").

Takéto správanie vyplýva z metodických pokynov finančnej správy sa online registračná pokladnica (koncové zariadenie) nesmie pokúsiť o viacnásobné zaslanie rovnakého dokladu.

Proces odoslania emailu má 3 fázy:

  1. nadviazanie sieťového spojenia s emailovým serverom: Ak tento krok zlyhá, aplikácia vyhlási chybu Spojenie s emailovým serverom sa nepodarilo nadviazať. Skontrolujte nastavenia e-mailového servera.. Ak systém hlási túto chybu, skúste v nastaveniach aplikácie vypnúť kontrolu SSL tak, že v "Typ pripojenia" zvolíte "Použiť TLS, ak je k dispozícii". Taktiež overte ostatné SMTP nastavenia.
  2. autentikácia emailového klienta (ak je v nastaveniach zapnuté, že je potrebné sa autentifikovať): Ak tento krok zlyhá, aplikácia vyhlási chybu Prihlásenie na emailovom serveri nebolo úspešné. Skontrolujte nastavenia e-mailového konta.. V tomto prípade sú pravdepodobne zle nastavené prihlasovacie údaje v nastaveniach aplikácie.
  3. samotné odoslanie emailu: Ak zlyhá s SMTP chybovým kódom RecipientNotAccepted, aplikácia vyhlási chybu Odoslanie e-mailu zlyhalo. E-mailová adresa príjemcu nebola akceptovaná.. Ak zlyhá s iným SMTP chybovým kódom, aplikácia vyhlási chybu Odoslanie e-mailu zlyhalo. Skontrolujte e-mailové nastavenia..

Výsledok registrácie dokladu

Po úspešnom alebo neuspešnom ukončení procesu registrácie dokladu sú aplikácii tretej strany vrátené informácie o uskutočnenej transakcii.

Návratový objekt obsahuje tieto vlastnosti:

Identifikátor Popis Dátový typ Poznámka
id Unikátny identifikátor generovaný koncovým zariadením string
request Objekt obsahujúci doklad z pôvodnej požiadavky RegistrationRequest Oproti dokladu z pôvodnej požiadavky tento objekt obsahuje niektoré vlastnosti doplnené koncovým zariadením, ktoré neboli súčasťou pôvodnej žiadosti o registráci dokladu.
response Objekt obsahujúci výsledok registrácie dokladu. RegistrationResponse Obsahuje vlastnosti error, eKasaError a eKasaErrorCode.
printer Tlačové nastavenia uvedené v požiadavke na registráciu dokladu receiptPrinter Objekt obsahujúci vlastnosti name a options.
creationDate Dátum a čas vytvorenia požidavky na zaevidovanie dokladu. date
createdBy Unikátny identifikátor používateľa, ktorý vytvoril požiadavku na registráciu dokladu. string
notificationDate Dátum a čas notifikovania koncového zariadenia date Dátum a čas, kedy došlo k notifikovaniu o vzniku novej požidavky a zaevodivanie dokladu a teda aj zmene stavu tejto požiadavky na Notified.
validityTimeSpan Časový interval platnosti požiadavky number Časový interval platnosti požiadavky vyjadrený milisekundách. Určuje maximálny časový interval od notifikovania koncového zariadenia (zmena na stav Notified) do prijatia požiadavky zo strany koncového zariadenia (zmena na stav Accepted). Ak nenastane zmena na stav Accepted v danom časovom úseku, stav požiadavky sa zmení na Expired.
acceptationDate Dátum a čas akceptácie požiadavky zo strany koncového zariadenia. date Dátum a čas, kedy došlo k akceptácií požiadavky registračnou pokladňou a teda aj zmene stavu tejto požiadavky na Accepted. Hodnota je null, ak nie je požiadavka aspoň v stave Accepted (teda ak je v niektorom zo stavov Created, Notified alebo Expired).
completionTimeSpan Časový interval pre vybavenie požiadavky. number Časový interval, vyjadrený v milisekundách, určený koncovým zariadením alebo serverom, počas ktorého by malo dôjsť k dokončeniu požiadavky evidencie dokladu. Hodnota je null, ak nie je požiadavka aspoň v stave Accepted.
completionDate Dátum a čas vybavenia požiadavky date Dátum a čas, kedy došlo k vybaveniu požiadavky koncovým zariadením alebo eKasa Cloud serverom a teda aj zmene stavu tejto požiadavky na jeden zo stavov Expired, Rejected, TimedOut, Processed, ProcessedOffline, ProcessFailed alebo Failed.
state Stav požiadavky evidencie dokladu. string Nadobúda niektorý zo stavov popísaných v sekcii Fázy registrácie dokladu.
error Informácie o chybe. registrationError Dostupném, ak je požiadavka v stave Failed.
rejectionReason Dôvod zamietnutia spracovania požiadavky zo strany koncového zariadenia. RegistrationRejectionReason Hodnota je k dispozícií iba ak požiadavka je v stave Rejected, v opačnom prípade nadobúda hodnotu null.

Oproti dokladu z pôvodnej požiadavky tento objekt obsahuje niektoré vlastnosti doplnené koncovým zariadením, ktoré neboli súčasťou pôvodnej žiadosti o registráci dokladu. Ide o tieto vlastnosti:

Identifikátor Popis Dátový typ Poznámka
orpCreateDate Dátum a čas vytvorenia požiadavky na koncovom zariadení date
receiptNumber Poradové číslo dokladu number Číslo priradené koncovým zariadením, číslované sekvenčne od 1, unikátne v rámci kalendárneho mesiaca.
dic DIČ obchodníka string
icdph IČDPH obchodníka string
ico IČO obchodníka string
paragon Indikácia, či ide o paragón boolean Nadobúda hodnotu true pre doklady typu paragon alebo invoiceParagon.
basicVatAmount Výška dane v základnej sadzbe DPH number
reducedVatAmount Výška dane v zníženej sadzbe DPH number
taxFreeAmount Obrat v nulovej sadzbe DPH number
taxBaseBasic Obrat v základnej sadzbe DPH number
taxBaseReduced Obrat v zníženej sadzbe DPH number
okp Overovací kód podnikateľa string
pkp Podpisový kód podnikateľa string
requestId ID požiadavky string
requestDate Dátum a čas požiadavky date
sendingCount Počet pokusov o odoslanie dokladu na server finančnej správy. number
receiptId ID dokladu priradené koncovým zariadením string
orpProcessDate Dátum a čas spracovania dokladu koncovým zariadením date

Clone this wiki locally