Registrácia Prihlásenie

API schémy parametra dokladu

Správa schémy vlastných parametrov patriacich k typom dokladov - získanie, zoznam, uloženie a odstránenie

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

https://{tenant}.logzi.com/api/receipt_param_schema/

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, v prípade chyby result.code == 0. Schéma určuje, aké vlastné parametre patria k danému typu dokladu (názov, typ, merná jednotka, poradie). Konkrétne hodnoty parametrov spravuje API parametra dokladu.

param_type_id možné hodnoty

Hodnota Názov Popis
1 Číslo Číselná hodnota, voliteľne s mernou jednotkou (param_unit_id)
2 Text Voľná textová hodnota
3 Logická hodnota Hodnota áno / nie
4 Zoznam hodnôt Výber spomedzi vopred zadaných možných hodnôt (param_enum)
GET /api/receipt_param_schema/get

Získanie jednej schémy parametra dokladu na základe identifikátora. Odstránené (remove = 1) schémy nevracia.

Parametre dotazu

Parameter Typ Povinné Popis
id int Jedinečný identifikátor schémy parametra

Príklad požiadavky

GET /api/receipt_param_schema/get?id=3
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 3,
    "receipt_type_id": 1,
    "param_type_id": 1,
    "param_name": "Hrubá hmotnosť",
    "param_enum": null,
    "param_order": 1,
    "param_unit_id": 4,
    "remove": 0
  }
}
GET /api/receipt_param_schema/list

Zoznam schém parametrov dokladov (bez odstránených schém), zoradený podľa typu dokladu, poradia zobrazenia a identifikátora. Zoznam nie je stránkovateľný. Odpoveď okrem polí schémy obsahuje aj názov typu parametra, typu dokladu a mernej jednotky.

Parametre dotazu

Parameter Typ Povinné Popis
list_condition[receipt_type_id] int Filtrovanie podľa identifikátora typu dokladu

Príklad požiadavky

GET /api/receipt_param_schema/list?list_condition[receipt_type_id]=1
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 3,
      "receipt_type_id": 1,
      "param_type_id": 1,
      "param_name": "Hrubá hmotnosť",
      "param_enum": null,
      "param_order": 1,
      "param_unit_id": 4,
      "remove": 0,
      "param_type_name": "Číslo",
      "receipt_type_name": "Skladová príjemka",
      "unit_name_short": "kg"
    },
    {
      "id": 4,
      "receipt_type_id": 1,
      "param_type_id": 4,
      "param_name": "Priorita",
      "param_enum": "[\"Nízka\",\"Normálna\",\"Naliehavá\"]",
      "param_order": 2,
      "param_unit_id": null,
      "remove": 0,
      "param_type_name": "Zoznam hodnôt",
      "receipt_type_name": "Skladová príjemka",
      "unit_name_short": null
    }
  ]
}
POST /api/receipt_param_schema/save

Vytvorenie alebo úprava schémy parametra dokladu. Pre novú schému zadajte data[id] = 0, pri úprave zadajte existujúci identifikátor.

POST polia - objekt data

Pole Typ Povinné Popis
id int 0 = nová schéma, >0 = úprava
receipt_type_id int Identifikátor typu dokladu, ku ktorému parameter patrí
param_type_id int Typ parametra (1 = číslo, 2 = text, 3 = logická hodnota, 4 = zoznam hodnôt)
param_name string Názov parametra (najviac 150 znakov)
param_enum array Pole vybrateľných hodnôt. Uloží sa iba pri param_type_id = 4 (uchovávané ako JSON, najviac 1000 znakov), pri iných typoch ho systém ignoruje.
param_order int Poradie zobrazenia (predvolené: 0)
param_unit_id int Identifikátor mernej jednotky. Pri hodnote 0 alebo prázdnej hodnote nie je merná jednotka.

Príklad požiadavky

POST /api/receipt_param_schema/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "receipt_type_id": 1,
    "param_type_id": 4,
    "param_name": "Priorita",
    "param_enum": ["Nízka", "Normálna", "Naliehavá"],
    "param_order": 2
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 4
  }
}
POST /api/receipt_param_schema/delete

Odstránenie schémy parametra dokladu na základe identifikátora. Odstránenie je logické: schéma dostane označenie remove = 1, následne ju dotazy nevracajú.

POST polia

Pole Typ Povinné Popis
id int Identifikátor schémy parametra určenej na odstránenie

Príklad požiadavky

POST /api/receipt_param_schema/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "id": 4
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}

Kontaktuj nás

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

Odoslať dopyt

Potrebuješ pomoc?

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

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia