Regisztráció Belépés

Kiegyenlítés API

Bizonylat kiegyenlítések kezelése — számlák és pénztárbizonylatokhoz rendelt pénzügyi teljesítések lekérése, rögzítése és törlése

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A kiegyenlítés egy bizonylat (számla vagy pénztárbizonylat) pénzügyi teljesítésének rögzítése.

GET /api/compensate/get

Egyetlen kiegyenlítés lekérése azonosító alapján, a kapcsolódó bizonylat adataival együtt.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA kiegyenlítés egyedi azonosítója

Példa kérés

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

Kiegyenlítések lapozható listájának lekérése 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[search_text]stringSzabad szavas keresés bizonylatszámra és partnernévre
list_condition[partner_company_name]stringSzűrés partner nevére (LIKE)
list_condition[receipt_identify]stringSzűrés bizonylatszámra (LIKE)
list_condition[invoice_receipt_type_id]intSzűrés bizonylat típusra
list_condition[invoice_receipt_id]intSzűrés bizonylat azonosítóra
list_condition[company_id]intCég azonosítója (alapértelmezett: 1)

Példa kérés

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

Kiegyenlítés rögzítése egy meglévő bizonylathoz (számla vagy pénztárbizonylat). A bizonylat azonosítható bizonylatszámmal, vevői rendelésszámmal vagy e-mail címmel.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idint0 = új kiegyenlítés (meglévő azonosítóval), >0 = módosítás
amountfloatKiegyenlített összeg
company_user_idintRögzítő munkatárs azonosítója
identify_invoicestringSzámla bizonylatszáma (ha számla alapján keresünk)
identify_customerstringVevői rendelésszám (ha rendelés alapján keresünk)
customer_emailstringVevő e-mail cím (ha e-mail alapján keresünk)
parcel_numberstringCsomagszám (ha szállítmány alapján keresünk)

Példa kérés

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

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

Kiegyenlítés törlése. Törlés után a kapcsolódó bizonylat ismét nyitottnak minősül.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA törlendő kiegyenlítés azonosítója

Példa kérés

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

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

Vedd fel a kapcsolatot velünk

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

Érdeklődés küldése

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

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

Nézz körbe a help centerben

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!
Regisztráció készítése
Regisztráció