Înregistrare Autentificare

API Fișier document

Gestionarea fișierelor atașate documentelor — încărcare, preluare și ștergere

Puncte finale

Autentificare

Fiecare cerere API necesită trimiterea header-ului X-API-KEY.

X-API-KEY: {cheia_dvs_api}

Mai ai întrebări?

Trimite-ne un tichet, sau caută în motorul nostru de căutare.

Dacă ți-a plăcut, distribuie-l și altora

URL de bază

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

Fiecare cerere returnează un răspuns JSON. În caz de succes, result.code == 1, în caz de eroare, result.code == 0. Fișierul document este un fișier binar atașat unui document (factură, comandă, contract etc.) — stocat cu conținut codificat în base64.

GET /api/receipt_file/get

Preluarea unui singur fișier document pe baza identificatorului.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul înregistrării fișierului

Exemplu de cerere

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

Lista paginată a fișierelor document, cu opțiuni de filtrare.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_condition[receipt_id]intFiltrare după identificatorul documentului
list_condition[receipt_type_id]intFiltrare după tipul documentului
list_condition[partner_id]intFiltrare pentru toate fișierele document ale unui partener

Exemplu de cerere

GET /api/receipt_file/list?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {cheia_dvs_api}
GET /api/receipt_file/list_light

Listă simplificată a fișierelor document — fără conținutul fișierului (file_source), doar cu metadate.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_conditionobjectCondiții de filtrare (ca la punctul final /list)

Exemplu de cerere

GET /api/receipt_file/list_light?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {cheia_dvs_api}
POST /api/receipt_file/save

Încărcarea unui fișier sau modificarea unuia existent. Pentru un fișier nou, data[id] = 0.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idint0 = fișier nou, >0 = modificare
receipt_type_idintIdentificatorul tipului de document
receipt_idintIdentificatorul documentului
file_namestringNumele fișierului cu extensie (ex. szamla.pdf)
file_sourcestringConținutul fișierului codificat în base64
file_type_idintIdentificatorul tipului de fișier (implicit: 1)
file_classification_idintIdentificatorul clasificării fișierului

Exemplu de cerere

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

Ștergerea unui fișier document pe baza identificatorului.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idintIdentificatorul fișierului care urmează să fie șters

Exemplu de cerere

POST /api/receipt_file/delete
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{ "data": { "id": 10 } }

Ia legătura cu noi

Ești interesat de software-ul nostru? Scrie-ne cu încredere!

Trimite o solicitare

Ai nevoie de ajutor?

Dacă nu găsești răspunsul și ai nevoie de asistență

Răsfoiește centrul de ajutor

Creează-ți contul acum,
plătește mai târziu!

Încearcă gratuit timp de 3 zile, fără riscuri și fără obligații!
Creare cont
Înregistrare