Faktúry

Základné informácie

Základné informácie k API, autentizáciu, stavové kódy, HTTP metódy, dátové typy a ďalšie nájdete na API v2 základné informácie

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ť definovám 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) - ak 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úvisiace faktúry, iba u dobropisu
      • 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_with_vat (float) - celková suma s DPH
      • total_without_vat (float) - celková čiastka bez DPH
      • note (string) - poznámka
      • invoice_pdf_url (string) - URL na PDF faktúru
      • supplier (object) - dodávateľ
        • email (string) - email
        • phone (string) - telefón
        • name (string) - meno osoby alebo názov firmy
        • street (string) - ulica a číslo
        • city (string) - mesto
        • zips (string) - PSČ
        • country_id (country) - stať
        • company_yn (bool) - príznak či je firma
        • var_payer_yn (bool) - príznak či je platiteľ 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) - email
        • phone (string) - telefón
        • name (string) - meno osoby alebo názov firmy
        • street (string) - ulica a číslo
        • city (string) - mesto
        • zips (string) - PSČ
        • country_id (country) - stať
        • 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 ak je položka produkt a je k u produktu zadaný, inak je hodnota null
        • name (string) - názov, len ak je položka produkt, inak je hodnota null
        • description (string) - opis
        • quantity (float) - počet kusov
        • unit (string) - jednotka
        • vat (float) - percentuálny 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ácie o EET (bude vyplnené iba u faktúry typu účtenka)
        • send_yn (bool) - príznak či sa má poslať do EET, určuje systém a to na základe nastavenia v eshope
        • production_yn (bool) - ak je hodnota 0, nie je v eshope aktivovaný produkčnej režim napojenia na EET a dáta sa do EET posielajú v neprodukčním testovacom režime
        • id_provoz (string) - ID prevádzkárne
        • id_pokl (string) - ID pokladničného zažízení
        • rezim (string) - režim EET, hodnoty:
          • common - bežný
          • simplified - zjednodušený
        • bkp (string) - BKP (bezpečnostný kód daňovníka)
        • fik (string) - FIK (fiškálna identifikačný kód)
        • PKP (string) - PKP (podpisový kód daňovníka)
      • recapitulation_currency_id (currency) - mena rekapitulácia DPH. Pokiaľ bude faktúra v inej mene ako je mena krajiny prevádzkovateľa esohpu, inými slovami ak eshop predáva do zahraničia, bude tu mena prevádzkovateľa eshopu, čiže mena v ktorej je prehľad DPH. Ak nie je uvedené, je prehľad DPH vo mene faktúry.
      • recapitulation_currency_rate (float) - kurz meny rekapitulácia DPH
      • recapitulation_vats (array) - prehľad DPH, pole objektov s jednotlivými hladinami DPH, kľúč poľa je percentuálny 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)

    HTTP/1.1 200 OK
Content-Type: application/json

{
    "current_page": "",
    "current_page_items": "",
    "number_of_pages": "",
    "number_of_items": "",
    "invoices": [
        {
            "invoice_number": "",
            "related_invoice_number": "",
            "type": "",
            "order_number": "",
            "external_order_number": "",
            "case_number": "",
            "language_id": "",
            "currency_id": "",
            "date_of_issuance": "",
            "date_of_vat_revenue_recognition": "",
            "date_of_expiration": "",
            "creation_time": "",
            "variable_symbol": "",
            "specific_symbol": "",
            "payment": "",
            "paid_yn": "",
            "paid_date": "",
            "total_with_vat": "",
            "total_without_vat": "",
            "note": "",
            "invoice_pdf_url": "",
            "supplier": {
                "email": "",
                "phone": "",
                "name": "",
                "street": "",
                "city": "",
                "zip": "",
                "country_id": "",
                "company_yn": "",
                "var_payer_yn": "",
                "ico": "",
                "dic": "",
                "account_number": "",
                "iban": "",
                "swift": "",
                "web": ""
            },
            "customer": {
                "email": "",
                "phone": "",
                "name": "",
                "street": "",
                "city": "",
                "zip": "",
                "country_id": "",
                "company_yn": "",
                "ico": "",
                "dic": ""
            },
            "items": [
                {
                    "description": "",
                    "info": "",
                    "unit": "",
                    "quantity": "",
                    "price_per_unit_with_vat": "",
                    "price_per_unit_without_vat": "",
                    "price_with_vat": "",
                    "price_without_vat": "",
                    "vat": ""
                }
            ],
            "eet": {
                "send_yn": "",
                "production_yn": "",
                "id_provoz": "",
                "id_pokl": "",
                "rezim": "",
                "bkp": "",
                "fik": "",
                "pkp": ""
            },
            "vats": [
                {
                    "base": "",
                    "vat": "",
                    "total": "",
                    "vat_value": ""
                }
            ],
            "vat_totals": {
                "base": "",
                "vat": "",
                "total": ""
            }
        }
    ]
}

PDF faktúra

Vracia faktúru vo formáte PDF

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

  • hlavičky odpovede (HTTP 200 OK)

    HTTP/1.1 200 OK
Content-Type: application/pdf