Înregistrare Autentificare

API compensare

Gestionarea compensărilor de documente — preluarea, înregistrarea și ștergerea plăților asociate facturilor și bonurilor de casă

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/compensate/

Fiecare cerere returnează un răspuns JSON. În caz de succes result.code == 1, în caz de eroare result.code == 0. Compensarea reprezintă înregistrarea plății unui document (factură sau bon de casă).

GET /api/compensate/get

Preluarea unei singure compensări, pe baza identificatorului, împreună cu datele documentului asociat.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul unic al compensării

Exemplu de cerere

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

Preluarea listei paginate de compensări, cu opțiuni de filtrare.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_condition[search_text]stringCăutare liberă după numărul documentului și numele partenerului
list_condition[partner_company_name]stringFiltrare după numele partenerului (LIKE)
list_condition[receipt_identify]stringFiltrare după numărul documentului (LIKE)
list_condition[invoice_receipt_type_id]intFiltrare după tipul documentului
list_condition[invoice_receipt_id]intFiltrare după identificatorul documentului
list_condition[company_id]intIdentificatorul companiei (implicit: 1)

Exemplu de cerere

GET /api/compensate/list?list_offset=0&list_condition[partner_company_name]=Minta
X-API-KEY: {cheia_dvs_api}
POST /api/compensate/save

Înregistrarea unei compensări pentru un document existent (factură sau bon de casă). Documentul poate fi identificat prin numărul documentului, numărul comenzii clientului sau adresa de e-mail.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
receipt_idint0 = compensare nouă (cu identificator existent), >0 = modificare
amountfloatSuma compensată
company_user_idintIdentificatorul angajatului care înregistrează
identify_invoicestringNumărul facturii (dacă se caută pe baza facturii)
identify_customerstringNumărul comenzii clientului (dacă se caută pe baza comenzii)
customer_emailstringAdresa de e-mail a clientului (dacă se caută pe baza e-mailului)
parcel_numberstringNumărul coletului (dacă se caută pe baza expedierii)

Exemplu de cerere

POST /api/compensate/save
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "receipt_id": 0,
    "amount": 127000,
    "company_user_id": 3,
    "identify_invoice": "2024/00123"
  }
}
POST /api/compensate/delete

Ștergerea unei compensări. După ștergere, documentul asociat va fi considerat din nou deschis.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
receipt_idintIdentificatorul compensării de șters

Exemplu de cerere

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

{ "data": { "receipt_id": 55 } }

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