Dokumentácia API - Faktúry

Základné informácie

Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie.

Niektoré údaje nie sú dostupné priamo vo faktúre, ale v detaile súvisiacej objednávky, kde ich je možné získať cez API. Viac tu.

Zoznam faktúr

• URI: /api/v2/invoices/{invoice_number}?invoice_numbers={invoice_numbers}&creation_time_from={creation_time_from}&last_update_time_from={last_update_time_from}&page={page}&paid_yn={paid_yn}&type={type}
• HTTP metóda: GET
• hlavičky:
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
• parametre (musí byť definovaný aspoň jeden parameter):
• invoice_number (string) - číslo faktúry
• invoice_numbers (string) - čísla faktúr oddelené bodkočiarkou ;
• creation_time_from (date) - vráti faktúry vytvorené od tohto dátumu
• last_update_time_from (date) - vráti faktúry zmenené od tohto dátumu
• page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1
• paid_yn (bool) - pokiaľ je 1, vráti zaplatené faktúry
• type (string) - typ dokladu, hodnoty sú:
• invoice - faktúra
• creditNote - dobropis
• receipt - účtenka

Odpoveď

Zoznam faktúr je dostupný po jednotlivých stranách, výstup je obmedzený na 100 položiek na stránku.

• telo
• current_page (int) - aktuálna strana
• current_page_items (int) - počet položiek na aktuálnej strane
• number_of_pages (int) - celkový počet strán
• number_of_items (int) - celkový počet položiek
• invoices (array) - pole objektov s faktúrami
• invoice_number (string) - číslo faktúry
• related_invoice_number (string) - číslo súvisiacej faktúry, len pri dobropise
• type (string) - typ faktúry, hodnoty:
• invoice - faktúra
• creditNote - dobropis
• receipt - účtenka
• order_number (string) - číslo objednávky
• external_order_number (string) - číslo objednávky z externého systému
• case_number (string) - číslo obchodného prípadu
• language_id (language) - jazyk faktúry
• currency_id (currency) - mena faktúry
• date_of_issuance (date) - dátum vystavenia
• date_of_vat_revenue_recognition (date) - dátum zdaniteľného plnenia
• date_of_expiration (date) - dátum splatnosti
• creation_time (date) - dátum vytvorenia
• variable_symbol (string) - variabilný symbol
• specific_symbol (string) - špecifický symbol
• payment (string) - platba
• paid_yn (bool) - zaplatené
• paid_date (date) - dátum zaplatenia
• total_rest (float) - zaokrúhlenie celkovej sumy
• total_with_vat (float) - celková suma s DPH
• total_without_vat (float) - celková suma bez DPH
• note (string) - poznámka
• invoice_pdf_url (string) - URL na PDF faktúru
• supplier (object) - dodávateľ
• email (string) - e-mail
• phone (string) - telefón
• name (string) - meno osoby alebo názov firmy
• street (string) - ulica a číslo
• city (string) - mesto
• zip (string) - PSČ
• country_id (country) - štát
• company_yn (bool) - príznak ak je firma
• var_payer_yn (bool) - príznak ak je platca DPH
• ico (string) - IČ
• dic (string) - DIČ
• account_number (string) - číslo účtu
• iban (string) - IBAN
• swift (string) - SWIFT
• web (string) - webová stránka
• customer (object) - zákazník
• email (string) - e-mail
• phone (string) - telefón
• name (string) - meno osoby alebo názov firmy
• street (string) - ulica a číslo
• city (string) - mesto
• zip (string) - PSČ
• country_id (country) - štát
• company_yn (bool) - príznak či je firma
• ico (string) - IČ
• dic (string) - DIČ
• items (array) - pole objektov s položkami
• code (string) - kód, len pokiaľ je položka produkt a je pri produkte zadaný, inak je hodnota null
• name (string) - názov, len pokiaľ je položka produkt, inak je hodnota null
• description (string) - popis
• quantity (float) - počet kusov
• unit (string) - jednotka
• vat (float) - percentuálna sadzba DPH
• price_per_unit_with_vat (float) - cena za jednotku s DPH
• price_per_unit_without_vat (float) - cena za jednotku bez DPH
• price_with_vat (float) - cena za s DPH
• price_without_vat (float) - cena za bez DPH
• eet (object) - informácia o EET (bude vyplnená len pri faktúre typu účtenka)
• send_yn (bool) - príznak, či sa má poslať do EET, určuje systém a to na základe nastavenia v e-shope
• production_yn (bool) - pokiaľ je hodnota 0, nie je v e-shope aktivovaný produkčný režim napojenia na EET a údaje sa do EET posielajú v neprodukčnom testovacom režime
• id_provoz (string) - ID prevádzkovne
• id_pokl (string) - ID pokladničného zariadenia
• rezim (string) - režim EET, hodnoty:
• common - bežný
• simplified - zjednodušený
• bkp (string) - BKP (bezpečnostný kód poplatníka)
• fik (string) - FIK (fiskálny identifikačný kód)
• pkp (string) - PKP (podpisový kód poplatníka)
• recapitulation_currency_id (currency) - mena rekapitulácie DPH. Pokiaľ bude faktúra v inej mene ako je mena krajiny prevádzkovateľa e-shopu, inými slovami pokiaľ e-shop predáva do zahraničia, bude tu mena prevádzkovateľa e-shopu, čiže mena, v ktorej je prehľad DPH. Pokiaľ nie je uvedené, je prehľad DPH v mene faktúry.
• recapitulation_currency_rate (float) - kurz meny rekapitulácie DPH
• recapitulation_vats (array) - prehľad DPH, pole objektov s jednotlivými hladinami DPH, kľúč poľa je percentuálna sadzba DPH
• base (float) - základ
• vat (float) - výška DPH
• total (float) - celkom s DPH
• recapitulation_vats_total (object) - prehľad DPH celkom
• base (float) - základ
• vat (float) - výška DPH
• total (float) - celkom s DPH

príklad odpovede (HTTP 200 OK)

PDF faktúra

Vracia faktúru vo formáte PDF.

• URI: /api/v2/invoices/{invoice_number}/pdf
  
  
• HTTP metóda: GET
  
  
• hlavičky:
  
  
• Authorization: Basic dGVzdDp0ZXN0
• Content-Type: application/json
• parametre:
  
  
• invoice_number (string) - číslo faktury

hlavičky odpovede (HTTP 200 OK)

HTTP/1.1 200 OK

• Content-Type: application/pdf