Invoice
idintegerID dokladu.
numberstring | nullČíslo dokladu; null u konceptu.
statusstringStav dokladu. Hodnoty: draft – koncept; issued – vystaveno; cancelled – stornováno. API doklad nestornuje, vystavený doklad se opravuje dobropisem.
payment_statusstringStav úhrady vypočtený k dnešnímu dni. Hodnoty: draft – koncept; unpaid – nezaplaceno; paid – zaplaceno; overdue – po splatnosti; future – datum vystavení je v budoucnu; issued – vystavená nabídka, ta se nehradí; cancelled – stornováno.
doc_typestringTyp dokladu. Doklady s DPH vyžadují, aby firma byla plátce DPH. Hodnoty: invoice_vat – faktura – daňový doklad; invoice_non_vat – faktura neplátce DPH; credit_note – opravný daňový doklad (dobropis); reverse_charge – faktura s přenesenou daňovou povinností; proforma – zálohová faktura; advance – daňový doklad k přijaté platbě; quote_vat – nabídka s DPH; quote_non_vat – nabídka bez DPH.
- Výchozí:
invoice_non_vat
issue_datedateDatum vystavení. Výchozí dnešní den.
supply_datedateDatum uskutečnění zdanitelného plnění (DUZP). Výchozí datum vystavení.
due_datedateDatum splatnosti. Výchozí 14 dní od vystavení.
contact_idinteger | nullID kontaktu odběratele. Pokud chybí customer, odběratel se převezme z kontaktu.
bank_account_idinteger | nullID bankovního účtu firmy, který se vytiskne na doklad.
payment_methodstringZpůsob úhrady. Hodnoty: bank_transfer – bankovní převod; cash – hotovost; cash_on_delivery – dobírka; card – platební karta; paypal – PayPal; mutual_offset – vzájemný zápočet.
- Výchozí:
bank_transfer
currencystringMěna ISO 4217.
- Výchozí:
CZK - Vzorec:
^[A-Z]{3}$
exchange_ratedecimalKurz k CZK. U CZK musí být 1, u jiné měny kurz ČNB ke dni zdanitelného plnění (1 se odmítne).
- Vzorec:
^-?\d{1,12}(\.\d{1,8})?$
languagestringJazyk dokladu. Hodnoty: cs – cs; sk – sk; en – en; de – de; de-AT – de-AT; pl – pl; fr – fr; nl – nl; es – es; uk – uk; sr – sr.
- Výchozí:
cs
vat_treatmentstringRežim DPH. Výchozí podle toho, zda je firma plátce DPH. Hodnoty: domestic – tuzemské plnění; non_payer – neplátce DPH; eu_goods – dodání zboží do EU; eu_services – služby do EU; domestic_reverse_charge – tuzemské přenesení daňové povinnosti; export – vývoz mimo EU; oss – prodej spotřebiteli v jiném státě EU v režimu OSS (sazba státu spotřeby, vyžaduje registraci k OSS).
roundingstringZaokrouhlení celkové částky. Hodnoty: none – bez zaokrouhlení; 0.10 – na desetníky; 0.50 – na padesátníky; 1.00 – na celé koruny.
- Výchozí:
none
templatestringVzhled PDF. Hodnoty: modern – moderní; simple – jednoduchý; custom – vlastní.
- Výchozí:
modern
colorstringBarva dokladu #RRGGBB. Výchozí barva firmy.
- Vzorec:
^#[0-9A-Fa-f]{6}$
show_qrbooleanTisknout QR platbu.
- Výchozí:
true
prices_include_vatbooleanJednotkové ceny jsou včetně DPH.
- Výchozí:
false
discount_pctdecimalSleva na celý doklad v procentech (0–100, nejvýše 2 desetinná místa).
- Vzorec:
^-?\d{1,12}(\.\d{1,8})?$
issued_bystringKdo doklad vystavil.
- Max. znaků:
120
notestring | nullPoznámka na dokladu.
- Max. znaků:
10000
reg_numberstring | nullEvidenční číslo.
- Max. znaků:
40
order_numberstring | nullČíslo objednávky odběratele.
- Max. znaků:
60
variable_symbolstring | nullVariabilní symbol, nejvýše 10 číslic. Při vystavení se jinak odvodí z čísla dokladu.
- Vzorec:
^\d{0,10}$
constant_symbolstring | nullKonstantní symbol.
- Max. znaků:
10
specific_symbolstring | nullSpecifický symbol.
- Max. znaků:
20
customer_snapshotPartyOdběratel tak, jak je uložen na dokladu.
Vnořená pole 10
namestringNázev firmy nebo jméno osoby.
- Max. znaků:
190
company_nostring | nullIČO. Mezery se odstraní.
- Max. znaků:
20
vat_nostring | nullDIČ.
- Max. znaků:
30
streetstring | nullUlice a číslo.
- Max. znaků:
190
citystring | nullObec.
- Max. znaků:
120
zipstring | nullPSČ.
- Max. znaků:
20
countrystring | nullKód země ISO 3166-1 alpha-2. Výchozí CZ.
- Výchozí:
CZ - Vzorec:
^[A-Za-z]{2}$
emailemail | nullE-mail; použije se jako výchozí příjemce faktury.
- Max. znaků:
190
phonestring | nullTelefon.
- Max. znaků:
40
webstring | nullWeb.
- Max. znaků:
190
supplier_snapshotobject | nullDodavatel (vaše firma) tak, jak je uložen na dokladu.
Vnořená pole 12
namestring | nullNázev firmy.
company_nostring | nullIČO.
vat_nostring | nullDIČ.
is_vat_payerbooleanPlátce DPH.
streetstring | nullUlice a číslo.
citystring | nullObec.
zipstring | nullPSČ.
countrystring | nullKód státu podle ISO 3166-1.
emailstring | nullE-mail.
phonestring | nullTelefon.
webstring | nullWeb.
register_notestring | nullZápis v obchodním rejstříku, jak je vytištěn na dokladu.
bank_snapshotobject | nullBankovní účet vytištěný na dokladu.
Vnořená pole 5
account_nostring | nullČíslo účtu s předčíslím.
bank_codestring | nullKód banky.
ibanstring | nullIBAN.
swiftstring | nullBIC (SWIFT).
currencystring | nullMěna účtu.
vat_summaryarray<object>Rekapitulace DPH podle sazeb.
paid_atdate | nullDatum úplné úhrady.
revisionintegerRevize; zvyšuje se při úpravě vystaveného dokladu.
related_invoice_idinteger | nullOpravovaný doklad.
recurring_idinteger | nullPravidelná fakturace, která doklad vytvořila.
scheduled_datedate | nullPlánované datum u pravidelné fakturace.
created_atdate-timeČas ISO 8601 s časovou zónou.
updated_atdate-timePoslední změna dokladu, včetně úhrady a smazání.
pdf_urluriOdkaz na PDF přes API.
itemsarray<InvoiceItem>Položky. Jen v detailu, ne v seznamu.
Vnořená pole 11
idintegerID položky.
positionintegerPořadí.
descriptionstringPopis položky.
- Max. znaků:
500
quantitydecimalMnožství, nejvýše 4 desetinná místa. Nesmí být 0; záporné jen u opravného dokladu. Výchozí 1.
- Vzorec:
^-?\d{1,12}(\.\d{1,8})?$
unitstringJednotka, například ks, hod. Výchozí ks.
- Max. znaků:
20
unit_pricedecimalJednotková cena, nejvýše 4 desetinná místa. Podle prices_include_vat bez DPH, nebo s DPH.
- Vzorec:
^-?\d{1,12}(\.\d{1,8})?$
vat_ratedecimalSazba DPH v procentech (0–100). U dokladů neplátce a přenesené daňové povinnosti se použije 0.
- Vzorec:
^-?\d{1,12}(\.\d{1,8})?$
correction_reasonstring | nullDůvod opravy u opravného daňového dokladu (credit_note). Při vystavení je povinný.
- Max. znaků:
255
reverse_charge_codestring | nullPředmět plnění při tuzemském přenesení daňové povinnosti (vat_treatment = domestic_reverse_charge), kód podle § 92a ZDPH pro kontrolní hlášení A.1, např. 4 – stavební a montážní práce.
- Hodnoty:
11a33a44a5671112131415161718192021null
vies_checkobject | nullOvěření DIČ odběratele v systému VIES při vystavení dokladu s režimem eu_goods nebo eu_services (§ 64 ZDPH). valid je null, když registr členského státu neodpověděl; neplatné DIČ vystavení zastaví.
- Pouze ke čtení
Vnořená pole 5
validboolean | nullnamestring | nulladdressstring | nullrequest_idstring | nullČíslo konzultace VIES.
checked_atdate-timeČas ISO 8601 s časovou zónou.
deleted_atdate-time | nullKdy byl záznam smazán. Smazané záznamy vrací jen seznam s updated_since, jinak null.