Regisztráció Belépés

Leltározás API

Leltárívek kezelése — lekérés, létrehozás, módosítás, lezárás, dokumentum letöltés és tételszintű lekérdezések

Leltárív végpontok

Tételsor 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-ek

https://{tenant}.logzi.com/api/inventory/ https://{tenant}.logzi.com/api/inventory_item/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/inventory/get

Egyetlen leltárív lekérése azonosító alapján, a hozzá tartozó tételsorokkal együtt.

Query paraméterek

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

Példa kérés

GET /api/inventory/get?id=5
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 5,
    "identify": "INV-2024-0005",
    "date_create": "2024-05-08 09:00:00",
    "date_perform": "2024-05-08",
    "status_id": 1,
    "store_id": 1,
    "company_user_name": "Kovács Péter",
    "item": [
      {
        "product_id": 12,
        "quantity_stock": 100,
        "quantity_found": 97,
        "store_locality_id": null
      }
    ]
  }
}
GET /api/inventory/list

Leltárívek listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_condition[identify] string Szűrés azonosítóra (LIKE)
list_condition[status_id] int Szűrés státuszra (1=nyitott, 2=lezárt)
list_condition[status_ids] array Szűrés több státuszra egyszerre
list_condition[company_user_id] int Szűrés felelős munkatárs ID-re
list_condition[date_create_from] date Létrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to] date Létrehozás dátuma — ig (YYYY-MM-DD)
list_condition[date_perform_from] date Teljesítés dátuma — tól (YYYY-MM-DD)
list_condition[date_perform_to] date Teljesítés dátuma — ig (YYYY-MM-DD)
list_condition[comment_bottom] string Szűrés belső megjegyzésre (LIKE)

Példa kérés

GET /api/inventory/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 5,
      "identify": "INV-2024-0005",
      "date_create": "2024-05-08",
      "status_name": "Nyitott",
      "company_user_name": "Kovács Péter"
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 3
  }
}
POST /api/inventory/save

Leltárív létrehozása vagy módosítása. Tételenként rögzíteni kell a nyilvántartott (quantity_stock) és a fizikailag megszámolt (quantity_found) mennyiséget. Új leltárívhez data[id] = 0.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új leltárív, >0 = módosítás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs ID
store_id int A leltározandó raktár azonosítója
currency_id int Pénznem azonosítója
currency_exchange decimal Devizaárfolyam
project_id int Projekt azonosítója
source_receipt_id int Forrásbizonylat azonosítója
source_receipt_type_id int Forrásbizonylat típusának azonosítója
item array Tételek tömbje — legalább egy tétel kötelező (ld. alább)

Tétel mezők — data[item][]

Mező Típus Kötelező Leírás
id int 0 = új tétel, >0 = meglévő tétel módosítása
product_id int Termék azonosítója
quantity_stock decimal Nyilvántartott (rendszer szerinti) mennyiség
quantity_found decimal Fizikailag megszámolt mennyiség
store_locality_id int Tárolóhely azonosítója
remove int 1 = tétel törlése módosításkor

POST mezők — params objektum (opcionális)

Mező Típus Kötelező Leírás
close int 1 = mentés után automatikus lezárás

Példa kérés

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

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "store_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 12,
        "quantity_stock": 100,
        "quantity_found": 97
      },
      {
        "id": 0,
        "product_id": 15,
        "quantity_stock": 50,
        "quantity_found": 50,
        "store_locality_id": 3
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 6,
    "identify": "INV-2024-0006"
  }
}
POST /api/inventory/delete

Leltárív törlése. Csak status_id = 1 (nyitott) vagy status_id = 2 (lezárt) bizonylat törölhető.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő leltárív azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 5
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/inventory/close

Nyitott leltárív lezárása. A lezárás elvégzi a készletkiegyenlítést a quantity_stock és quantity_found értékek különbsége alapján. Csak status_id = 1 (nyitott) bizonylat zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó leltárív azonosítója

Példa kérés

POST /api/inventory/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "receipt_id": 5
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/inventory/download

Leltárív dokumentumának generálása különböző formátumokban (PDF, base64 string, stream).

Query paraméterek

Paraméter Típus Kötelező Leírás
receipt_id int A leltárív azonosítója
file_type string Kimeneti formátum (ld. alább)
language string Sablon nyelvi mappa neve (pl. hungarian)
language_id int Nyelv azonosítója (alapértelmezett: 1)
template_id int Egyedi nyomtatási sablon ID

file_type lehetséges értékek

Érték Leírás
pdf Base64 kódolt PDF visszaadása metaadatokkal
pdf-string Azonos a pdf-fel — base64 string + metaadat
pdf-string-sample Előnézeti PDF generálás
stream Közvetlen fájl stream (böngésző letöltés)

Példa kérés

GET /api/inventory/download?receipt_id=5&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Példa válasz (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "INV-2024-0005.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Tételsor végpontok

Az /api/inventory_item/ végpontok egy adott leltárív tételeinek részletes lekérdezésére szolgálnak. Tételek írása és törlése a leltárív mentésén (/api/inventory/save) keresztül történik.

GET /api/inventory_item/get

Egyetlen leltárív-tétel lekérése azonosító alapján.

Paraméter Típus Kötelező Leírás
id int A leltárív-tétel egyedi azonosítója

Példa kérés

GET /api/inventory_item/get?id=88
X-API-KEY: {az_api_kulcsod}
GET /api/inventory_item/list

Egy leltárív összes tételének lekérése.

Paraméter Típus Kötelező Leírás
inventory_sheet_id int A leltárív azonosítója

Példa kérés

GET /api/inventory_item/list?inventory_sheet_id=5
X-API-KEY: {az_api_kulcsod}
GET /api/inventory_item/list_tax

Egy leltárív tételeinek ÁFA-kulcsonkénti összesítése.

Paraméter Típus Kötelező Leírás
inventory_sheet_id int A leltárív azonosítója

Példa kérés

GET /api/inventory_item/list_tax?inventory_sheet_id=5
X-API-KEY: {az_api_kulcsod}
GET /api/inventory_item/list_slim

Leltárív-tételek lapozható, szűrhető lekérése — raktár és státusz alapján is szűrhető.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_condition[inventory_sheet_id] int Szűrés leltárív ID-re
list_condition[store_id] int Szűrés raktár ID-re
list_condition[status_id] int Szűrés a leltárív státuszára

Példa kérés

GET /api/inventory_item/list_slim?list_condition[inventory_sheet_id]=5&list_offset=0
X-API-KEY: {az_api_kulcsod}

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ó