Přejít na obsah
FakturanetAPI v1.0.0
OpenAPI API klíče

Objekty

Invoice

idinteger

ID dokladu.

numberstring | null

Číslo dokladu; null u konceptu.

statusstring

Stav dokladu. Hodnoty: draft – koncept; issued – vystaveno; cancelled – stornováno. API doklad nestornuje, vystavený doklad se opravuje dobropisem.

payment_statusstring

Stav ú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_typestring

Typ 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_datedate

Datum vystavení. Výchozí dnešní den.

supply_datedate

Datum uskutečnění zdanitelného plnění (DUZP). Výchozí datum vystavení.

due_datedate

Datum splatnosti. Výchozí 14 dní od vystavení.

contact_idinteger | null

ID kontaktu odběratele. Pokud chybí customer, odběratel se převezme z kontaktu.

bank_account_idinteger | null

ID bankovního účtu firmy, který se vytiskne na doklad.

payment_methodstring

Způ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
currencystring

Měna ISO 4217.

  • Výchozí: CZK
  • Vzorec: ^[A-Z]{3}$
exchange_ratedecimal

Kurz 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})?$
languagestring

Jazyk 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_treatmentstring

Rež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).

roundingstring

Zaokrouhlení 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
templatestring

Vzhled PDF. Hodnoty: modern – moderní; simple – jednoduchý; custom – vlastní.

  • Výchozí: modern
colorstring

Barva dokladu #RRGGBB. Výchozí barva firmy.

  • Vzorec: ^#[0-9A-Fa-f]{6}$
show_qrboolean

Tisknout QR platbu.

  • Výchozí: true
prices_include_vatboolean

Jednotkové ceny jsou včetně DPH.

  • Výchozí: false
discount_pctdecimal

Sleva na celý doklad v procentech (0–100, nejvýše 2 desetinná místa).

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
issued_bystring

Kdo doklad vystavil.

  • Max. znaků: 120
notestring | null

Poznámka na dokladu.

  • Max. znaků: 10000
reg_numberstring | null

Evidenční číslo.

  • Max. znaků: 40
order_numberstring | null

Číslo objednávky odběratele.

  • Max. znaků: 60
variable_symbolstring | null

Variabilní symbol, nejvýše 10 číslic. Při vystavení se jinak odvodí z čísla dokladu.

  • Vzorec: ^\d{0,10}$
constant_symbolstring | null

Konstantní symbol.

  • Max. znaků: 10
specific_symbolstring | null

Specifický symbol.

  • Max. znaků: 20
customer_snapshotParty

Odběratel tak, jak je uložen na dokladu.

Vnořená pole 10
namestring

Název firmy nebo jméno osoby.

  • Max. znaků: 190
company_nostring | null

IČO. Mezery se odstraní.

  • Max. znaků: 20
vat_nostring | null

DIČ.

  • Max. znaků: 30
streetstring | null

Ulice a číslo.

  • Max. znaků: 190
citystring | null

Obec.

  • Max. znaků: 120
zipstring | null

PSČ.

  • Max. znaků: 20
countrystring | null

Kód země ISO 3166-1 alpha-2. Výchozí CZ.

  • Výchozí: CZ
  • Vzorec: ^[A-Za-z]{2}$
emailemail | null

E-mail; použije se jako výchozí příjemce faktury.

  • Max. znaků: 190
phonestring | null

Telefon.

  • Max. znaků: 40
webstring | null

Web.

  • Max. znaků: 190
supplier_snapshotobject | null

Dodavatel (vaše firma) tak, jak je uložen na dokladu.

Vnořená pole 12
namestring | null

Název firmy.

company_nostring | null

IČO.

vat_nostring | null

DIČ.

is_vat_payerboolean

Plátce DPH.

streetstring | null

Ulice a číslo.

citystring | null

Obec.

zipstring | null

PSČ.

countrystring | null

Kód státu podle ISO 3166-1.

emailstring | null

E-mail.

phonestring | null

Telefon.

webstring | null

Web.

register_notestring | null

Zápis v obchodním rejstříku, jak je vytištěn na dokladu.

bank_snapshotobject | null

Bankovní účet vytištěný na dokladu.

Vnořená pole 5
account_nostring | null

Číslo účtu s předčíslím.

bank_codestring | null

Kód banky.

ibanstring | null

IBAN.

swiftstring | null

BIC (SWIFT).

currencystring | null

Měna účtu.

vat_summaryarray<object>

Rekapitulace DPH podle sazeb.

Vnořená pole 4

Sazba DPH v %.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$

Základ.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$

DPH.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
grossdecimal

Celkem.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
total_netdecimal

Základ celkem.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
total_vatdecimal

DPH celkem.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
total_grossdecimal

Celkem k úhradě.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
rounding_amountdecimal

Haléřové vyrovnání.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
paid_amountdecimal

Uhrazeno.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
paid_atdate | null

Datum úplné úhrady.

revisioninteger

Revize; zvyšuje se při úpravě vystaveného dokladu.

related_invoice_idinteger | null

Opravovaný doklad.

recurring_idinteger | null

Pravidelná fakturace, která doklad vytvořila.

scheduled_datedate | null

Plánované datum u pravidelné fakturace.

created_atdate-time

Čas ISO 8601 s časovou zónou.

updated_atdate-time

Poslední změna dokladu, včetně úhrady a smazání.

pdf_urluri

Odkaz na PDF přes API.

Položky. Jen v detailu, ne v seznamu.

Vnořená pole 11
idinteger

ID položky.

positioninteger

Pořadí.

descriptionstring

Popis položky.

  • Max. znaků: 500
quantitydecimal

Množ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})?$
unitstring

Jednotka, například ks, hod. Výchozí ks.

  • Max. znaků: 20
unit_pricedecimal

Jednotková cena, nejvýše 4 desetinná místa. Podle prices_include_vat bez DPH, nebo s DPH.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
discount_pctdecimal

Sleva na položku v procentech.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
vat_ratedecimal

Sazba 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})?$

Základ.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$

DPH.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
grossdecimal

Celkem s DPH.

  • Vzorec: ^-?\d{1,12}(\.\d{1,8})?$
correction_reasonstring | null

Důvod opravy u opravného daňového dokladu (credit_note). Při vystavení je povinný.

  • Max. znaků: 255
reverse_charge_codestring | null

Př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: 1 1a 3 3a 4 4a 5 6 7 11 12 13 14 15 16 17 18 19 20 21 null
vies_checkobject | null

Ověř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 | null
namestring | null
addressstring | null
request_idstring | null

Číslo konzultace VIES.

checked_atdate-time

Čas ISO 8601 s časovou zónou.

deleted_atdate-time | null

Kdy byl záznam smazán. Smazané záznamy vrací jen seznam s updated_since, jinak null.

Hledat v dokumentaci

Hledejte endpoint, pole, objekt, typ chyby nebo téma příručky.