Regisztráció Belépés

Raktári bevét API

Raktári bevétek 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/booking/

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

Egyetlen raktári bevét lekérése azonosító alapján, teljes részletekkel (tételek, sorozatszámok, projekt).

Query paraméterek

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

Példa kérés

GET /api/booking/get?id=42
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 42,
    "identify": "BK-2024-0042",
    "date_create": "2024-05-01 10:00:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 127000,
    "price_netto": 100000,
    "price_tax": 27000,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 50000,
        "price_brutto": 63500
      }
    ]
  }
}
GET /api/booking/list

Raktári bevétek 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[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[partner_id] int Szűrés partner ID-re

Példa kérés

GET /api/booking/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": 42,
      "identify": "BK-2024-0042",
      "date_create": "2024-05-01",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 127000
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 87
  }
}
POST /api/booking/save

Raktári bevét létrehozása vagy módosítása. Új bevéthez 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 raktári bevét, >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_shipping_id int Partner szállítási cím ID
comment_top string Ügyfelnek látható megjegyzés
comment_bottom string Belső megjegyzés
jobnumber_id int Munkaszám azonosítója
project_id int Projekt azonosítója
item array Tételek tömbje (ld. alább)

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

Mező Típus Kötelező Leírás
product_id int Termék azonosítója
store_id int Raktár azonosítója
quantity float Mennyiség
tax_id int ÁFA kulcs azonosítója
price float Nettó egységár
price_discount float Kedvezmény százaléka
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/booking/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-15 09:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "comment_top": "Kérjük csomagolt szállítást.",
    "item": [
      {
        "product_id": 5,
        "store_id": 1,
        "quantity": 3,
        "tax_id": 2,
        "price": 15000
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 43,
    "identify": "BK-2024-0043"
  }
}
POST /api/booking/delete

Raktári bevét törlése. Csak nyitott (status_id=1) vagy lezárt (status_id=2) bevét törölhető, amennyiben a sorozatszámok nincsenek felhasználva.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A törlendő raktári bevét azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 42
  }
}

Példa válasz

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

Nyitott raktári bevét lezárása. A lezárás készletmozgást és mennyiségi validációt hajt végre. Csak status_id = 1 (nyitott) bevét zárható le.

POST mezők — data objektum

Mező Típus Kötelező Leírás
receipt_id int A lezárandó raktári bevét azonosítója

Példa kérés

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

{
  "data": {
    "receipt_id": 42
  }
}

Példa válasz

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

Raktári bevét dokumentumának letöltése/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 raktári bevét 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 (ID alapú kereséshez)
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/booking/download?receipt_id=42&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Példa válasz (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "BK-2024-0042.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ó