Registrácia Prihlásenie

Faktúra API

Správa vydaných faktúr — načítanie, vytvorenie, úprava, uzavretie a integrácia s NAV

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

https://{tenant}.logzi.com/api/invoice/

Koncový bod faktúr spravuje vydané faktúry, zálohové faktúry, ručné faktúry a proforma faktúry. Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.

GET /api/invoice/get

Načítanie jednej vydanej faktúry na základe identifikátora, s kompletnými podrobnosťami (položky, partner, súhrny).

Query parametre

Parameter Typ Povinné Popis
id int Jedinečný identifikátor faktúry
identify string Dá sa vyhľadať aj podľa identifikátora (napr. SZ-2024-0042)

Príklad požiadavky

GET /api/invoice/get?id=42
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 42,
    "identify": "SZ-2024-0042",
    "date_create": "2024-05-01 10:00:00",
    "date_perform": "2024-05-10",
    "date_pay": "2024-05-24",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 127000,
    "price_netto": 100000,
    "price_tax": 27000,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 50000,
        "price_brutto": 63500
      }
    ]
  }
}
GET /api/invoice/list

Stránkovateľné načítanie zoznamu vydaných faktúr s možnosťami filtrovania a zoradenia.

Query parametre

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_count int Počet výsledkov na stránku (predvolené: 10)
list_sort[field] string Názov poľa na zoradenie
list_sort[sort] string ASC alebo DESC
list_condition[identify] string Filter podľa identifikátora (LIKE)
list_condition[company_name] string Filter podľa názvu partnera (LIKE)
list_condition[status_id] int Filter podľa stavu (1=otvorená, 2=uzavretá)
list_condition[date_create_from] date Dátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to] date Dátum vytvorenia — do (YYYY-MM-DD)
list_condition[partner_id] int Filter podľa ID partnera

Príklad požiadavky

GET /api/invoice/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 42,
      "identify": "SZ-2024-0042",
      "date_create": "2024-05-01",
      "date_pay": "2024-05-24",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 127000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 156
  }
}
POST /api/invoice/save

Vytvorenie alebo úprava vydanej faktúry. Pre novú faktúru zadajte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nová faktúra, >0 = úprava
company_id int Identifikátor firmy
company_user_id int ID zodpovedného pracovníka
company_address_id int ID prevádzky firmy
currency_id int Identifikátor meny
date_perform date Dátum plnenia (YYYY-MM-DD)
partner_id int Identifikátor partnera/odberateľa
partner_shipping_id int ID dodacej adresy partnera
date_pay date Termín splatnosti (YYYY-MM-DD)
paymod_id int Identifikátor spôsobu platby
comment_top string Poznámka v hlavičke faktúry
comment_bottom string Poznámka v päte faktúry
jobnumber_id int Identifikátor pracovného čísla
project_id int Identifikátor projektu
item array Pole položiek — aspoň jedna položka je povinná (pozri nižšie)

Polia položky — data[item][]

Pole Typ Povinné Popis
product_id int Identifikátor produktu
quantity float Množstvo
price float Netto jednotková cena
tax_id int Identifikátor sadzby DPH
price_discount float Percento zľavy
remove int 1 = odstránenie položky pri úprave

POST polia — objekt params (voliteľné)

Pole Typ Povinné Popis
close int 1 = automatické uzavretie po uložení
download int 1 = generovanie PDF po uložení

Príklad požiadavky

POST /api/invoice/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 12,
    "date_perform": "2024-06-15",
    "date_pay": "2024-06-29",
    "paymod_id": 2,
    "comment_top": "Köszönjük a megrendelést!",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 50000,
        "tax_id": 2
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 43,
    "identify": "SZ-2024-0043"
  }
}
POST /api/invoice/delete

Odstránenie vydanej faktúry. Odstrániť možno iba otvorenú faktúru (status_id = 1).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor faktúry určenej na odstránenie

Príklad požiadavky

POST /api/invoice/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "receipt_id": 42
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/invoice/close

Uzavretie otvorenej vydanej faktúry. Pri uzavretí sa faktúra finalizuje a môže byť nahlásená NAV (Online Számla). Uzavrieť možno iba faktúru so status_id = 1 (otvorená).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor faktúry určenej na uzavretie

Príklad požiadavky

POST /api/invoice/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "receipt_id": 42
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/invoice/download

Stiahnutie/generovanie dokumentu faktúry v rôznych formátoch (PDF, base64 reťazec, stream).

Query parametre

Parameter Typ Povinné Popis
receipt_id int Identifikátor faktúry
file_type string Výstupný formát (pozri nižšie)
language string Názov jazykového priečinka šablóny (napr. hungarian)
language_id int Identifikátor jazyka (na vyhľadávanie podľa ID)
template_id int ID vlastnej tlačovej šablóny

Možné hodnoty file_type

Hodnota Popis
pdf Vrátenie PDF kódovaného v Base64 spolu s metadátami
pdf-string Rovnaké ako pdf — base64 reťazec + metadáta
pdf-string-sample Generovanie náhľadového PDF
stream Priamy súborový stream (stiahnutie v prehliadači)

Príklad požiadavky

GET /api/invoice/download?receipt_id=42&file_type=pdf
X-API-KEY: {vas_api_kluc}

Príklad odpovede (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "SZ-2024-0042.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia