Základná URL
https://{tenant}.logzi.com/api/receipt_comment/
Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Poznámka dokladu je vopred definovaný text, ktorý sa môže automaticky vložiť do hlavičky alebo päty dokladu — na základe spôsobu platby alebo typu dokladu.
/api/receipt_comment/get
Načítanie jednej šablóny poznámky podľa identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor šablóny poznámky |
Príklad požiadavky
GET /api/receipt_comment/get?id=1
X-API-KEY: {vas_api_kluc}
/api/receipt_comment/list
Stránkovateľný zoznam šablón poznámok.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt s filtračnými podmienkami |
Príklad požiadavky
GET /api/receipt_comment/list?list_offset=0
X-API-KEY: {vas_api_kluc}
/api/receipt_comment/save
Vytvorenie alebo úprava šablóny poznámky. Pre novú šablónu data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nová šablóna, >0 = úprava | |
comment_name | string | Názov poznámky (pre internú identifikáciu) | |
comment_value | string | Text poznámky | |
receipt_type_id | int | Identifikátor typu dokladu | |
receipt_comment_type_id | int | Typ poznámky (hlavička / päta) | |
receipt_comment_auto_fill | int | 1 = automatické vyplnenie | |
receipt_comment_paymod_id | int | Filter podľa spôsobu platby (ak NULL: pre všetky spôsoby platby) |
Príklad požiadavky
POST /api/receipt_comment/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"comment_name": "Átutalásos megjegyzés",
"comment_value": "Kérjük az összeget 8 napon belül átutalni.",
"receipt_type_id": 8,
"receipt_comment_type_id": 2,
"receipt_comment_auto_fill": 1,
"receipt_comment_paymod_id": 2
}
}
/api/receipt_comment/delete
Odstránenie šablóny poznámky podľa identifikátora.
POST polia
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor poznámky, ktorá sa má odstrániť |
Príklad požiadavky
POST /api/receipt_comment/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "id": 1 }
Zaregistruj sa teraz,
zaplať neskôr!