Regisztráció Belépés

Bizonylat paraméter séma API

Bizonylattípusokhoz tartozó egyedi paraméterek sémájának kezelése - lekérés, lista, mentés és törlés

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A séma határozza meg, hogy egy bizonylattípushoz milyen egyedi paraméterek tartoznak (név, típus, mértékegység, sorrend). A paraméterek konkrét értékeit a Bizonylat paraméter API kezeli.

param_type_id lehetséges értékek

Érték Megnevezés Leírás
1 Szám Numerikus érték, opcionálisan mértékegységgel (param_unit_id)
2 Szöveg Szabad szöveges érték
3 Logikai Igen / nem érték
4 Értékkészlet Előre megadott lehetséges értékek közül választható (param_enum)
GET /api/receipt_param_schema/get

Egyetlen bizonylat paraméter séma lekérése azonosító alapján. A törölt (remove = 1) sémákat nem adja vissza.

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A paraméter séma egyedi azonosítója

Példa kérés

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

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 3,
    "receipt_type_id": 1,
    "param_type_id": 1,
    "param_name": "Bruttó tömeg",
    "param_enum": null,
    "param_order": 1,
    "param_unit_id": 4,
    "remove": 0
  }
}
GET /api/receipt_param_schema/list

Bizonylat paraméter sémák listája (a törölt sémák nélkül), bizonylattípus, megjelenítési sorrend és azonosító szerint rendezve. A lista nem lapozható. A válasz a sémák mezői mellett a paraméter típus, a bizonylattípus és a mértékegység nevét is tartalmazza.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_condition[receipt_type_id] int Szűrés a bizonylattípus azonosítójára

Példa kérés

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

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 3,
      "receipt_type_id": 1,
      "param_type_id": 1,
      "param_name": "Bruttó tömeg",
      "param_enum": null,
      "param_order": 1,
      "param_unit_id": 4,
      "remove": 0,
      "param_type_name": "Szám",
      "receipt_type_name": "Raktári bevét",
      "unit_name_short": "kg"
    },
    {
      "id": 4,
      "receipt_type_id": 1,
      "param_type_id": 4,
      "param_name": "Prioritás",
      "param_enum": "[\"Alacsony\",\"Normál\",\"Sürgős\"]",
      "param_order": 2,
      "param_unit_id": null,
      "remove": 0,
      "param_type_name": "Értékkészlet",
      "receipt_type_name": "Raktári bevét",
      "unit_name_short": null
    }
  ]
}
POST /api/receipt_param_schema/save

Bizonylat paraméter séma létrehozása vagy módosítása. Új sémához data[id] = 0, módosításhoz a meglévő azonosítót kell megadni.

POST mezők - data objektum

Mező Típus Kötelező Leírás
id int 0 = új séma, >0 = módosítás
receipt_type_id int Bizonylattípus azonosítója, amelyhez a paraméter tartozik
param_type_id int A paraméter típusa (1 = szám, 2 = szöveg, 3 = logikai, 4 = értékkészlet)
param_name string A paraméter megnevezése (legfeljebb 150 karakter)
param_enum array A választható értékek tömbje. Csak param_type_id = 4 esetén kerül mentésre (JSON-ként tárolva, legfeljebb 1000 karakter), egyéb típusnál a rendszer figyelmen kívül hagyja.
param_order int Megjelenítési sorrend (alapértelmezett: 0)
param_unit_id int Mértékegység azonosítója. 0 vagy üres érték esetén nincs mértékegység.

Példa kérés

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

{
  "data": {
    "id": 0,
    "receipt_type_id": 1,
    "param_type_id": 4,
    "param_name": "Prioritás",
    "param_enum": ["Alacsony", "Normál", "Sürgős"],
    "param_order": 2
  }
}

Példa válasz

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

Bizonylat paraméter séma törlése azonosító alapján. A törlés logikai: a séma remove = 1 jelölést kap, ezután a lekérdezések nem adják vissza.

POST mezők

Mező Típus Kötelező Leírás
id int A törlendő paraméter séma azonosítója

Példa kérés

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

{
  "id": 4
}

Példa válasz

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

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció