Základná URL
https://{tenant}.logzi.com/api/compensate/
Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API kompenzácie slúži na vzájomné započítanie (kompenzáciu) pohľadávok a záväzkov, s podporou hromadného importu.
/api/compensate/get
Získanie jedného kompenzačného dokladu podľa identifikátora.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor kompenzácie |
Príklad požiadavky
GET /api/compensate/get?id=1
X-API-KEY: {vas_api_kluc}/api/compensate/list
Stránkovateľný zoznam kompenzačných dokladov.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtračných podmienok |
Príklad požiadavky
GET /api/compensate/list?list_offset=0
X-API-KEY: {vas_api_kluc}/api/compensate/save
Vytvorenie alebo úprava kompenzačného dokladu.
POST polia — objekt data
V objekte data je potrebné zadať údaje kompenzácie (identifikátor partnera, prepojené doklady, sumu).
Príklad požiadavky
POST /api/compensate/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }/api/compensate/save_import
Hromadný import kompenzačných dokladov.
POST polia — pole data
V poli data je možné zadať údaje viacerých kompenzačných dokladov naraz na hromadné zaznamenanie.
Príklad požiadavky
POST /api/compensate/save_import
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": [ { "partner_id": 1 }, { "partner_id": 2 } ] }/api/compensate/delete
Odstránenie kompenzačného dokladu.
POST polia — objekt data
V objekte data je potrebné zadať údaje kompenzácie, ktorá sa má odstrániť.
Príklad požiadavky
POST /api/compensate/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }Zaregistruj sa teraz,
zaplať neskôr!
