API pre stav dokladu

Správa stavov dokladov — získavanie, preklady a vytváranie

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.

GET /api/receipt_status/get

Získanie jedného stavu dokladu podľa identifikátora a jazyka.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor stavu
language_idintIdentifikátor jazyka prekladu

Príklad požiadavky

GET /api/receipt_status/get?id=1&language_id=1
X-API-KEY: {vas_api_kluc}
GET /api/receipt_status/get_all

Získanie všetkých stavov dokladov — bez filtrovania.

Query parametre

ParameterTypPovinnéPopis
idintVoliteľný filter podľa identifikátora stavu

Príklad požiadavky

GET /api/receipt_status/get_all
X-API-KEY: {vas_api_kluc}
GET /api/receipt_status/list

Stránkovaný zoznam stavov dokladov.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt filtračných podmienok
language_idintIdentifikátor jazyka prekladu

Príklad požiadavky

GET /api/receipt_status/list?language_id=1
X-API-KEY: {vas_api_kluc}
POST /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

PoleTypPovinnéPopis
idint0 = nový stav, >0 = úprava
name_keystringKľúčový názov stavu (prekladový kľúč)
outer_resource_namestringNázov stavu v externom systéme
dataobjectObjekt 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" }
  }
}
POST /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

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

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!