Regisztráció Belépés

Bizonylat paraméter API

Bizonylatokhoz rendelt paraméterértékek kezelése - lekérés, lista és menté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/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. Egy rekord egy bizonylathoz tartozó egyetlen paraméter értékét tárolja; a paraméter szerkezetét a Bizonylat paraméter séma API írja le.

GET /api/receipt_param/get

Egyetlen bizonylat paraméter érték lekérése. A paraméter séma azonosítója és/vagy a bizonylat azonosítója alapján keres, a találati sorok közül az elsőt adja vissza. Legalább az egyik paraméter megadása kötelező, ellenkező esetben a válasz Not found.

Query paraméterek

Paraméter Típus Kötelező Leírás
param_schema_id int A paraméter séma azonosítója (legalább ez vagy a receipt_id kötelező)
receipt_id int A bizonylat azonosítója (legalább ez vagy a param_schema_id kötelező)

Példa kérés

GET /api/receipt_param/get?param_schema_id=3&receipt_id=42
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 17,
    "param_schema_id": 3,
    "param_value": "125.5",
    "receipt_type_id": 1,
    "receipt_id": 42
  }
}
GET /api/receipt_param/list

Bizonylat paraméter értékek listája. A lista nem lapozható, a találatok egy tömbben érkeznek. Szűrés nélkül az összes rekordot visszaadja.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_condition[receipt_id] int Szűrés a bizonylat azonosítójára
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/list?list_condition[receipt_id]=42
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 17,
      "param_schema_id": 3,
      "param_value": "125.5",
      "receipt_type_id": 1,
      "receipt_id": 42
    },
    {
      "id": 18,
      "param_schema_id": 4,
      "param_value": "Sürgős",
      "receipt_type_id": 1,
      "receipt_id": 42
    }
  ]
}
POST /api/receipt_param/save

Bizonylat paraméter érték mentése. Ha az adott bizonylathoz és paraméter sémához már van rekord (param_schema_id + receipt_id), a mentés módosítja azt, egyébként új rekordot hoz létre. A válaszban a rekord azonosítója szerepel.

POST mezők - data objektum

Mező Típus Kötelező Leírás
param_schema_id int A paraméter séma azonosítója (0-nál nagyobb)
receipt_id int A bizonylat azonosítója (0-nál nagyobb)
receipt_type_id int A bizonylattípus azonosítója
param_value string A paraméter értéke szövegként (legfeljebb 1500 karakter). A séma param_type_id típusától függően szám, szöveg, logikai érték vagy értékkészlet-elem.

Példa kérés

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

{
  "data": {
    "param_schema_id": 3,
    "receipt_id": 42,
    "receipt_type_id": 1,
    "param_value": "125.5"
  }
}

Példa válasz

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

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ó