Alap URL
https://{tenant}.logzi.com/api/receipt_file/
Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A bizonylat fájl egy bizonylathoz (számla, rendelés, szerződés stb.) csatolt bináris fájl — base64 kódolt tartalommal tárolva.
/api/receipt_file/get
Egyetlen bizonylat fájl lekérése azonosító alapján.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
id | int | Fájl rekord azonosítója |
Példa kérés
GET /api/receipt_file/get?id=10
X-API-KEY: {az_api_kulcsod}
/api/receipt_file/list
Bizonylat fájlok lapozható listája szűré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_condition[receipt_id] | int | Szűrés bizonylat azonosítóra | |
list_condition[receipt_type_id] | int | Szűrés bizonylat típusra | |
list_condition[partner_id] | int | Szűrés partner összes bizonylat fájljára |
Példa kérés
GET /api/receipt_file/list?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {az_api_kulcsod}
/api/receipt_file/list_light
Bizonylat fájlok könnyű listája — fájltartalom (file_source) nélkül, csak metaadatokkal.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
list_offset | int | Lapozás eltolása (alapértelmezett: 0) | |
list_condition | object | Szűrési feltételek (mint /list végpontnál) |
Példa kérés
GET /api/receipt_file/list_light?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {az_api_kulcsod}
/api/receipt_file/save
Fájl feltöltése vagy meglévő módosítása. Új fájlhoz data[id] = 0.
POST mezők — data objektum
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
id | int | 0 = új fájl, >0 = módosítás | |
receipt_type_id | int | Bizonylat típus azonosítója | |
receipt_id | int | Bizonylat azonosítója | |
file_name | string | Fájlnév kiterjesztéssel (pl. szamla.pdf) | |
file_source | string | Fájl tartalma base64 kódolva | |
file_type_id | int | Fájl típus azonosítója (alapértelmezett: 1) | |
file_classification_id | int | Fájl osztályozás azonosítója |
Példa kérés
POST /api/receipt_file/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json
{
"data": {
"id": 0,
"receipt_type_id": 8,
"receipt_id": 150,
"file_name": "szamla_150.pdf",
"file_source": "JVBERi0x..."
}
}
/api/receipt_file/delete
Bizonylat fájl törlése azonosító alapján.
POST mezők — data objektum
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
id | int | A törlendő fájl azonosítója |
Példa kérés
POST /api/receipt_file/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json
{ "data": { "id": 10 } }
Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!
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!