API pre skladové príjemky

Správa skladových príjemiek — získanie, vytvorenie, úprava, uzavretie a stiahnutie dokumentu

Základná URL

https://{tenant}.logzi.com/api/booking/

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.

GET /api/booking/get

Získanie jednej skladovej príjemky na základe identifikátora, s kompletnými podrobnosťami (položky, sériové čísla, projekt).

Parametre dotazu

Parameter Typ Povinné Popis
id int Jedinečný identifikátor skladovej príjemky

Príklad požiadavky

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

Príklad odpovede

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

Stránkovateľné získanie zoznamu skladových príjemiek s možnosťami filtrovania.

Parametre dotazu

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_condition[identify] string Filtrovanie podľa identifikátora (LIKE)
list_condition[company_name] string Filtrovanie podľa názvu partnera (LIKE)
list_condition[status_id] int Filtrovanie podľa stavu (1=otvorená, 2=uzavretá)
list_condition[date_create_from] date Dátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to] date Dátum vytvorenia — do (YYYY-MM-DD)
list_condition[partner_id] int Filtrovanie podľa ID partnera

Príklad požiadavky

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

Príklad odpovede

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

Vytvorenie alebo úprava skladovej príjemky. Pre novú príjemku zadajte data[id] = 0, pri úprave zadajte existujúce ID.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nová skladová príjemka, >0 = úprava
company_id int Identifikátor spoločnosti
company_user_id int ID zodpovedného pracovníka
company_address_id int ID prevádzky spoločnosti
date_perform datetime Dátum plnenia (YYYY-MM-DD HH:MM:SS)
currency_id int Identifikátor meny
partner_id int Identifikátor partnera/zákazníka
partner_shipping_id int ID dodacej adresy partnera
comment_top string Poznámka viditeľná pre zákazníka
comment_bottom string Interná poznámka
jobnumber_id int Identifikátor čísla zákazky
project_id int Identifikátor projektu
item array Pole položiek (pozri nižšie)

Polia položky — data[item][]

Pole Typ Povinné Popis
product_id int Identifikátor produktu
store_id int Identifikátor skladu
quantity float Množstvo
tax_id int Identifikátor sadzby DPH
price float Jednotková cena bez DPH
price_discount float Percento zľavy
remove int 1 = odstránenie položky pri úprave

POST polia — objekt params (voliteľné)

Pole Typ Povinné Popis
close int 1 = automatické uzavretie po uložení
download int 1 = generovanie PDF po uložení

Príklad požiadavky

POST /api/booking/save
X-API-KEY: {vas_api_kluc}
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
  }
}

Príklad odpovede

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

Odstránenie skladovej príjemky. Odstrániť možno iba otvorenú (status_id=1) alebo uzavretú (status_id=2) príjemku, pokiaľ nie sú použité sériové čísla.

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor skladovej príjemky určenej na odstránenie

Príklad požiadavky

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

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

Príklad odpovede

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

Uzavretie otvorenej skladovej príjemky. Uzavretie vykoná pohyb zásob a validáciu množstva. Uzavrieť možno iba príjemku so status_id = 1 (otvorená).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor skladovej príjemky určenej na uzavretie

Príklad požiadavky

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

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

Príklad odpovede

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

Stiahnutie/generovanie dokumentu skladovej príjemky v rôznych formátoch (PDF, base64 reťazec, stream).

Parametre dotazu

Parameter Typ Povinné Popis
receipt_id int Identifikátor skladovej príjemky
file_type string Výstupný formát (pozri nižšie)
language string Názov jazykového priečinka šablóny (napr. hungarian)
language_id int Identifikátor jazyka (na vyhľadávanie podľa ID)
template_id int ID vlastnej tlačovej šablóny

file_type možné hodnoty

Hodnota Popis
pdf Vrátenie PDF kódovaného v base64 s metadátami
pdf-string Rovnaké ako pdf — base64 reťazec + metadáta
pdf-string-sample Generovanie náhľadového PDF
stream Priamy súborový stream (stiahnutie v prehliadači)

Príklad požiadavky

GET /api/booking/download?receipt_id=42&file_type=pdf
X-API-KEY: {vas_api_kluc}

Príklad odpovede (file_type=pdf)

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

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!