Számla API

Kimenő számlák kezelése — lekérés, létrehozás, módosítás, lezárás és NAV-integráció

Alap URL

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

A számla végpont kezeli a kimenő számlákat, előleg számlákat, kézi számlákat és díjbekérőket. Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/invoice/get

Egyetlen kimenő számla lekérése azonosító alapján, teljes részletekkel (tételek, partner, összesítők).

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A számla egyedi azonosítója
identify string Azonosító alapján is lekérhető (pl. SZ-2024-0042)

Példa kérés

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

Példa válasz

{
  "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

Kimenő számlák listájának lapozható lekérése szűrési és rendezési lehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_count int Oldalankénti találatok száma (alapértelmezett: 10)
list_sort[field] string Rendezési mező neve
list_sort[sort] string ASC vagy DESC
list_condition[identify] string Szűrés azonosítóra (LIKE)
list_condition[company_name] string Szűrés partner nevére (LIKE)
list_condition[status_id] int Szűrés státuszra (1=nyitott, 2=lezárt)
list_condition[date_create_from] date Létrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to] date Létrehozás dátuma — ig (YYYY-MM-DD)
list_condition[partner_id] int Szűrés partner ID-re

Példa kérés

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

Példa válasz

{
  "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

Kimenő számla létrehozása vagy módosítása. Új számlához data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új számla, >0 = módosítás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs ID
company_address_id int Cég telephely ID
currency_id int Pénznem azonosítója
date_perform date Teljesítés dátuma (YYYY-MM-DD)
partner_id int Partner/vevő azonosítója
partner_shipping_id int Partner szállítási cím ID
date_pay date Fizetési határidő (YYYY-MM-DD)
paymod_id int Fizetési mód azonosítója
comment_top string Számlán megjelenő fejléc megjegyzés
comment_bottom string Számlán megjelenő lábléc megjegyzés
jobnumber_id int Munkaszám azonosítója
project_id int Projekt azonosítója
item array Tételek tömbje — legalább egy tétel kötelező (ld. alább)

Tétel mezők — data[item][]

Mező Típus Kötelező Leírás
product_id int Termék azonosítója
quantity float Mennyiség
price float Nettó egységár
tax_id int ÁFA kulcs azonosítója
price_discount float Kedvezmény százaléka
remove int 1 = tétel törlése módosításkor

POST mezők — params objektum (opcionális)

Mező Típus Kötelező Leírás
close int 1 = mentés után automatikus lezárás
download int 1 = mentés után PDF generálás

Példa kérés

POST /api/invoice/save
X-API-KEY: {az_api_kulcsod}
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
  }
}

Példa válasz

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

Kimenő számla törlése. Csak nyitott (status_id = 1) számla törölhető.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő számla azonosítója

Példa kérés

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

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

Példa válasz

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

Nyitott kimenő számla lezárása. Lezáráskor a számla véglegesítésre kerül, és NAV felé jelentésre kerülhet (Online Számla). Csak status_id = 1 (nyitott) számla zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó számla azonosítója

Példa kérés

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

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

Példa válasz

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

Számla dokumentumának letöltése/generálása különböző formátumokban (PDF, base64 string, stream).

Query paraméterek

Paraméter Típus Kötelező Leírás
receipt_id int A számla azonosítója
file_type string Kimeneti formátum (ld. alább)
language string Sablon nyelvi mappa neve (pl. hungarian)
language_id int Nyelv azonosítója (ID alapú kereséshez)
template_id int Egyedi nyomtatási sablon ID

file_type lehetséges értékek

Érték Leírás
pdf Base64 kódolt PDF visszaadása metaadatokkal
pdf-string Azonos a pdf-fel — base64 string + metaadat
pdf-string-sample Előnézeti PDF generálás
stream Közvetlen fájl stream (böngésző letöltés)

Példa kérés

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

Példa válasz (file_type=pdf)

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

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!