Bizonylat fájl API

Bizonylatokhoz csatolt fájlok kezelése — feltöltés, lekérés és törlés

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.

GET /api/receipt_file/get

Egyetlen bizonylat fájl lekérése azonosító alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintFájl rekord azonosítója

Példa kérés

GET /api/receipt_file/get?id=10
X-API-KEY: {az_api_kulcsod}
GET /api/receipt_file/list

Bizonylat fájlok lapozható listája szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_condition[receipt_id]intSzűrés bizonylat azonosítóra
list_condition[receipt_type_id]intSzűrés bizonylat típusra
list_condition[partner_id]intSzű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}
GET /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éterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_conditionobjectSzű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}
POST /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ípusKötelezőLeírás
idint0 = új fájl, >0 = módosítás
receipt_type_idintBizonylat típus azonosítója
receipt_idintBizonylat azonosítója
file_namestringFájlnév kiterjesztéssel (pl. szamla.pdf)
file_sourcestringFájl tartalma base64 kódolva
file_type_idintFájl típus azonosítója (alapértelmezett: 1)
file_classification_idintFá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..."
  }
}
POST /api/receipt_file/delete

Bizonylat fájl törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA 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 } }

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!