Základná URL
https://{tenant}.logzi.com/api/receipt_status/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Stav dokladu je stav zobrazovaný na dokladoch — napr. naplánovaný, uzavretý, uhradený. K stavom je možné uložiť aj jazykové preklady.
/api/receipt_status/get
Získanie jedného stavu dokladu podľa identifikátora a jazyka.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor stavu | |
language_id | int | Identifikátor jazyka prekladu |
Príklad požiadavky
GET /api/receipt_status/get?id=1&language_id=1
X-API-KEY: {vas_api_kluc}
/api/receipt_status/get_all
Získanie všetkých stavov dokladov — bez filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Voliteľný filter podľa identifikátora stavu |
Príklad požiadavky
GET /api/receipt_status/get_all
X-API-KEY: {vas_api_kluc}
/api/receipt_status/list
Stránkovaný zoznam stavov dokladov.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtračných podmienok | |
language_id | int | Identifikátor jazyka prekladu |
Príklad požiadavky
GET /api/receipt_status/list?language_id=1
X-API-KEY: {vas_api_kluc}
/api/receipt_status/save
Vytvorenie alebo úprava stavu dokladu. Pre nový stav data[id] = 0. Pole data môže obsahovať aj jazykové preklady.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový stav, >0 = úprava | |
name_key | string | Kľúčový názov stavu (prekladový kľúč) | |
outer_resource_name | string | Názov stavu v externom systéme | |
data | object | Objekt prekladov: { "1": "Tervezett", "2": "Planned" } (kľúč = language_id) |
Príklad požiadavky
POST /api/receipt_status/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"name_key": "receipt_status_custom",
"outer_resource_name": "PENDING",
"data": { "1": "Várakozik", "2": "Pending" }
}
}
/api/receipt_status/delete
Odstránenie stavu dokladu podľa identifikátora. Odstrániť možno iba stavy, ktoré sú označené ako odstrániteľné (removeable = 1).
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor stavu, ktorý sa má odstrániť |
Príklad požiadavky
POST /api/receipt_status/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 5 } }
Zaregistruj sa teraz,
zaplať neskôr!