Regisztráció Belépés

Készlet foglalás API

Készlet foglalások kezelése — lekérés, létrehozás, módosítás, lezárás és dokumentum letölté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/reserve/

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/reserve/get

Egyetlen készlet foglalás lekérése azonosító alapján, teljes részletekkel (tételek, készletadatok, projekt).

Query paraméterek

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

Példa kérés

GET /api/reserve/get?id=23
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 23,
    "identify": "RES-2024-0023",
    "date_create": "2024-05-05 09:15:00",
    "date_perform": "2024-05-20",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 95000,
    "price_netto": 74803,
    "price_tax": 20197,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 8,
        "quantity": 5,
        "price": 14961,
        "price_brutto": 19000
      }
    ]
  }
}
GET /api/reserve/list

Készlet foglalások 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[company_name] string Szűrés partner nevére (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[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[partner_id] int Szűrés partner ID-re
list_condition[company_user_id] int Szűrés felelős munkatárs ID-re
list_condition[partnumber] string Szűrés cikkszámra vagy vonalkódra (LIKE)
list_condition[comment_top] string Szűrés ügyfelnek látható megjegyzésre (LIKE)
list_condition[comment_bottom] string Szűrés belső megjegyzésre (LIKE)

Példa kérés

GET /api/reserve/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": 23,
      "identify": "RES-2024-0023",
      "date_create": "2024-05-05",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 95000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 12
  }
}
POST /api/reserve/save

Készlet foglalás létrehozása vagy módosítása. Új foglaláshoz data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új készlet foglalás, >0 = módosítás
company_id int Cég azonosítója
company_user_id int Felelős munkatárs ID
company_address_id int Cég telephely ID
date_perform datetime Teljesítés dátuma (YYYY-MM-DD HH:MM:SS)
currency_id int Pénznem azonosítója
partner_id int Partner/ügyfél azonosítója
partner_user_id int Partner kapcsolattartó ID
partner_shipping_id int Partner szállítási cím ID
currency_exchange decimal Devizaárfolyam (alapértelmezett: 1)
comment_top string Ügyfelnek látható megjegyzés
comment_bottom string Belső megjegyzés
jobnumber_id int Munkaszám azonosítója
departmentnumber_id int Részlegszám azonosítója
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
store_id int Raktár azonosítója
store_locality_id int Tárolóhely azonosítója
pallet_id int Raklap azonosítója
quantity decimal Mennyiség
tax_id int ÁFA kulcs azonosítója
price decimal Nettó egységár
price_discount decimal Kedvezmény/felár százaléka
stock_change int Készletmozgás jelzője
comment_top string Tételhez tartozó megjegyzés
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
download int 1 = mentés után PDF generálás

Példa kérés

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

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "date_perform": "2024-06-20 00:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 8,
        "store_id": 1,
        "quantity": 5,
        "tax_id": 2,
        "price": 14961
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 24,
    "identify": "RES-2024-0024"
  }
}
POST /api/reserve/delete

Készlet foglalás 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ő készlet foglalás azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 23
  }
}

Példa válasz

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

Nyitott készlet foglalás lezárása. 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ó készlet foglalás azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 23
  }
}

Példa válasz

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

Készlet foglalás 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 készlet foglalás 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/reserve/download?receipt_id=23&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Példa válasz (file_type=pdf)

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

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ó