API rezervácie zásob

Správa rezervácií zásob — získanie, vytvorenie, úprava, uzavretie a stiahnutie dokumentu

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.

GET /api/reserve/get

Získanie jednej rezervácie zásob podľa identifikátora, s kompletnými podrobnosťami (položky, údaje o zásobách, projekt).

Parametre dopytu

Parameter Typ Povinné Popis
id int Jedinečný identifikátor rezervácie zásob

Príklad požiadavky

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

Príklad odpovede

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

Stránkovateľné získanie zoznamu rezervácií zásob s možnosťami filtrovania.

Parametre dopytu

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[status_ids] array Filtrovanie podľa viacerých stavov naraz
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[date_perform_from] date Dátum plnenia — od (YYYY-MM-DD)
list_condition[date_perform_to] date Dátum plnenia — do (YYYY-MM-DD)
list_condition[partner_id] int Filtrovanie podľa ID partnera
list_condition[company_user_id] int Filtrovanie podľa ID zodpovedného pracovníka
list_condition[partnumber] string Filtrovanie podľa čísla produktu alebo čiarového kódu (LIKE)
list_condition[comment_top] string Filtrovanie podľa poznámky viditeľnej pre zákazníka (LIKE)
list_condition[comment_bottom] string Filtrovanie podľa internej poznámky (LIKE)

Príklad požiadavky

GET /api/reserve/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": 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

Vytvorenie alebo úprava rezervácie zásob. Pre novú rezerváciu zadajte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — data objekt

Pole Typ Povinné Popis
id int 0 = nová rezervácia zásob, >0 = úprava
company_id int Identifikátor firmy
company_user_id int ID zodpovedného pracovníka
company_address_id int ID prevádzky firmy
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_user_id int ID kontaktnej osoby partnera
partner_shipping_id int ID dodacej adresy partnera
currency_exchange decimal Výmenný kurz (predvolené: 1)
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
departmentnumber_id int Identifikátor čísla strediska
project_id int Identifikátor projektu
source_receipt_id int Identifikátor zdrojového dokladu
source_receipt_type_id int Identifikátor typu zdrojového dokladu
item array Pole položiek — aspoň jedna položka je povinná (pozri nižšie)

Polia položky — data[item][]

Pole Typ Povinné Popis
id int 0 = nová položka, >0 = úprava existujúcej položky
product_id int Identifikátor produktu
store_id int Identifikátor skladu
store_locality_id int Identifikátor skladovej pozície
pallet_id int Identifikátor palety
quantity decimal Množstvo
tax_id int Identifikátor sadzby DPH
price decimal Jednotková cena bez DPH
price_discount decimal Percento zľavy/prirážky
stock_change int Príznak pohybu zásob
comment_top string Poznámka k položke
remove int 1 = zmazanie položky pri úprave

POST polia — params objekt (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/reserve/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-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
  }
}

Príklad odpovede

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

Zmazanie rezervácie zásob. Zmazať možno iba doklad so status_id = 1 (otvorený) alebo status_id = 2 (uzavretý).

POST polia — data objekt

Pole Typ Povinné Popis
receipt_id int Identifikátor rezervácie zásob určenej na zmazanie

Príklad požiadavky

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

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

Príklad odpovede

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

Uzavretie otvorenej rezervácie zásob. Uzavrieť možno iba doklad so status_id = 1 (otvorený).

POST polia — data objekt

Pole Typ Povinné Popis
receipt_id int Identifikátor rezervácie zásob určenej na uzavretie

Príklad požiadavky

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

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

Príklad odpovede

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

Generovanie dokumentu rezervácie zásob v rôznych formátoch (PDF, reťazec base64, stream).

Parametre dopytu

Parameter Typ Povinné Popis
receipt_id int Identifikátor rezervácie zásob
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 (predvolené: 1)
template_id int ID vlastnej tlačovej šablóny

Možné hodnoty file_type

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

Príklad požiadavky

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

Príklad odpovede (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "RES-2024-0023.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!