Registrácia Prihlásenie

API skladovej výdajky

Správa skladových výdajok — získavanie, vytváranie, úprava, uzavretie a sťahovanie dokumentov

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

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

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

Query parametre

Parameter Typ Povinné Popis
id int Jedinečný identifikátor skladovej výdajky
item_params[include_pictures] int 1 = vrátenie obrázkov produktov pri položkách
item_params[include_items_stock_serial] int 1 = vrátenie údajov o sériových číslach
item_params[include_items_product_parts] int 1 = vrátenie zložiek produktu
item_params[include_receipt_cr] int 1 = vrátenie súvisiacich dokladov

Príklad požiadavky

GET /api/outgoing/get?id=17&item_params[include_items_stock_serial]=1
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 17,
    "identify": "OUT-2024-0017",
    "date_create": "2024-05-03 11:20:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 63500,
    "price_netto": 50000,
    "price_tax": 13500,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 25000,
        "price_brutto": 31750
      }
    ]
  }
}
GET /api/outgoing/list

Stránkovateľné získanie zoznamu skladových výdajok s možnosťami filtrovania a triedenia.

Query parametre

Parameter Typ Povinné Popis
list_offset int Posun stránkovania (predvolené: 0)
list_count int Počet výsledkov na stránku (predvolené: 10)
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 položky alebo čiarového kódu (LIKE)
list_condition[serial_number] string Filtrovanie podľa sériového čísla
list_sort[field] string Názov poľa na triedenie
list_sort[sort] string ASC alebo DESC

Príklad požiadavky

GET /api/outgoing/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": 17,
      "identify": "OUT-2024-0017",
      "date_create": "2024-05-03",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 63500
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 34
  }
}
POST /api/outgoing/save

Vytvorenie alebo úprava skladovej výdajky. Pre novú výdajku uveďte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — objekt data

Pole Typ Povinné Popis
id int 0 = nová skladová výdajka, >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/klienta
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 klienta
comment_bottom string Interná poznámka
jobnumber_id int Identifikátor pracovného čísla
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 skladového miesta
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 skladového pohybu
comment_top string Poznámka k položke
remove int 1 = zmazanie 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/outgoing/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,
    "item": [
      {
        "id": 0,
        "product_id": 5,
        "store_id": 1,
        "quantity": 2,
        "tax_id": 2,
        "price": 25000
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 18,
    "identify": "OUT-2024-0018"
  }
}
POST /api/outgoing/delete

Zmazanie skladovej výdajky. Zmazať možno len doklad so status_id = 1 (otvorený) alebo status_id = 2 (uzavretý).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor skladovej výdajky určenej na zmazanie

Príklad požiadavky

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

{
  "data": {
    "receipt_id": 17
  }
}

Príklad odpovede

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

Uzavretie otvorenej skladovej výdajky. Vykoná skladový pohyb a validáciu množstva pri produktoch evidovaných na sklade. Uzavrieť možno len doklad so status_id = 1 (otvorený).

POST polia — objekt data

Pole Typ Povinné Popis
receipt_id int Identifikátor skladovej výdajky určenej na uzavretie

Príklad požiadavky

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

{
  "data": {
    "receipt_id": 17
  }
}

Príklad odpovede

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

Generovanie dokumentu skladovej výdajky v rôznych formátoch (PDF, base64 reťazec, stream).

Query parametre

Parameter Typ Povinné Popis
receipt_id int Identifikátor skladovej výdajky
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 — base64 reťazec + 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/outgoing/download?receipt_id=17&file_type=pdf
X-API-KEY: {vas_api_kluc}

Príklad odpovede (file_type=pdf)

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

Kontaktuj nás

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

Odoslať dopyt

Potrebuješ pomoc?

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

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia