Poznámka dokladu API

Správa preddefinovaných šablón poznámok k dokladom — na automatické vypĺňanie textu

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.

GET /api/receipt_comment/get

Načítanie jednej šablóny poznámky podľa identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor šablóny poznámky

Príklad požiadavky

GET /api/receipt_comment/get?id=1
X-API-KEY: {vas_api_kluc}
GET /api/receipt_comment/list

Stránkovateľný zoznam šablón poznámok.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt s filtračnými podmienkami

Príklad požiadavky

GET /api/receipt_comment/list?list_offset=0
X-API-KEY: {vas_api_kluc}
POST /api/receipt_comment/save

Vytvorenie alebo úprava šablóny poznámky. Pre novú šablónu data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová šablóna, >0 = úprava
comment_namestringNázov poznámky (pre internú identifikáciu)
comment_valuestringText poznámky
receipt_type_idintIdentifikátor typu dokladu
receipt_comment_type_idintTyp poznámky (hlavička / päta)
receipt_comment_auto_fillint1 = automatické vyplnenie
receipt_comment_paymod_idintFilter 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
  }
}
POST /api/receipt_comment/delete

Odstránenie šablóny poznámky podľa identifikátora.

POST polia

PoleTypPovinnéPopis
idintIdentifiká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 }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!