Registrácia Prihlásenie

API parametra dokladu

Správa hodnôt parametrov priradených k dokladom - získanie, zoznam a uloženie

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/

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. Jeden záznam uchováva hodnotu jedného parametra patriaceho k jednému dokladu; štruktúru parametra popisuje API schémy parametra dokladu.

GET /api/receipt_param/get

Získanie hodnoty jedného parametra dokladu. Vyhľadáva podľa identifikátora schémy parametra a/alebo identifikátora dokladu a z nájdených riadkov vráti prvý. Zadanie aspoň jedného z parametrov je povinné, inak je odpoveď Not found.

Parametre dotazu

Parameter Typ Povinné Popis
param_schema_id int Identifikátor schémy parametra (povinný je aspoň tento alebo receipt_id)
receipt_id int Identifikátor dokladu (povinný je aspoň tento alebo param_schema_id)

Príklad požiadavky

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

Príklad odpovede

{
  "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

Zoznam hodnôt parametrov dokladov. Zoznam nie je stránkovateľný, výsledky prichádzajú v jednom poli. Bez filtrovania vráti všetky záznamy.

Parametre dotazu

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

Príklad požiadavky

GET /api/receipt_param/list?list_condition[receipt_id]=42
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "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": "Naliehavá",
      "receipt_type_id": 1,
      "receipt_id": 42
    }
  ]
}
POST /api/receipt_param/save

Uloženie hodnoty parametra dokladu. Ak pre daný doklad a schému parametra už existuje záznam (param_schema_id + receipt_id), uloženie ho upraví, v opačnom prípade vytvorí nový záznam. V odpovedi sa nachádza identifikátor záznamu.

POST polia - objekt data

Pole Typ Povinné Popis
param_schema_id int Identifikátor schémy parametra (väčší ako 0)
receipt_id int Identifikátor dokladu (väčší ako 0)
receipt_type_id int Identifikátor typu dokladu
param_value string Hodnota parametra ako text (najviac 1500 znakov). Podľa typu param_type_id schémy ide o číslo, text, logickú hodnotu alebo položku zo zoznamu hodnôt.

Príklad požiadavky

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

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

Príklad odpovede

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

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