Registrácia Prihlásenie

API objednávky dodávateľovi

Správa objednávok dodávateľovi — získanie, vytvorenie, úprava, uzavretie a stiahnutie dokumentu

Koncové body

GET Získanie záznamu
GET Získanie zoznamu
POST Uloženie / vytvorenie
POST Vymazanie
POST Uzavretie
GET Stiahnutie

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.

Základná URL

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

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

GET/api/order_out/get

Získanie jednej objednávky dodávateľovi podľa identifikátora, s úplnými podrobnosťami.

Query parametre

Parameter	Typ	Povinné	Popis
`id`	int		Jedinečný identifikátor objednávky dodávateľovi

Príklad požiadavky

GET /api/order_out/get?id=55
X-API-KEY: {vas_api_kluc}

GET/api/order_out/list

Stránkovateľné získanie zoznamu objednávok dodávateľovi s možnosťami filtrovania.

Query parametre

Parameter	Typ	Popis
`list_offset`	int	Posun stránkovania (predvolené: 0)
`list_count`	int	Počet záznamov zobrazených na stránku
`list_sort[field]`	string	Názov poľa na zoradenie
`list_sort[sort]`	string	Smer zoradenia: `ASC` alebo `DESC`
`list_condition[identify]`	string	Filtrovanie podľa identifikátora (LIKE)
`list_condition[company_name]`	string	Filtrovanie podľa názvu dodávateľa (LIKE)
`list_condition[status_id]`	int	Filtrovanie podľa stavu
`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 dodávateľa

Príklad požiadavky

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

POST/api/order_out/save

Vytvorenie alebo úprava objednávky dodávateľovi. Pre novú objednávku data[id] = 0, pri úprave zadajte existujúce ID.

POST polia — objekt data

Pole	Typ	Popis
`id`	int	0 = nová objednávka, >0 = úprava
`company_id`	int	Identifikátor firmy
`company_user_id`	int	ID zodpovedného zamestnanca
`company_address_id`	int	ID prevádzky firmy
`currency_id`	int	Identifikátor meny
`partner_id`	int	Identifikátor partnera dodávateľa
`date_perform`	date	Termín dodania (YYYY-MM-DD)
`comment_top`	string	Poznámka viditeľná pre dodávateľa
`comment_bottom`	string	Interná poznámka
`jobnumber_id`	int	Identifikátor pracovného čísla
`project_id`	int	Identifikátor projektu
`item`	array	Pole položiek (pozri nižšie)

Polia položky — data[item][]

Pole	Typ	Popis
`product_id`	int	Identifikátor produktu
`quantity`	float	Objednané množstvo
`price`	float	Jednotková cena bez DPH
`tax_id`	int	Identifikátor sadzby DPH
`price_discount`	float	Percento zľavy
`store_id`	int	Identifikátor cieľového skladu
`remove`	int	1 = vymazanie 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/order_out/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,
    "currency_id": 1,
    "partner_id": 8,
    "date_perform": "2024-07-01",
    "item": [
      { "product_id": 2, "quantity": 100, "price": 500, "tax_id": 2 }
    ]
  }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 56, "identify": "SZR-2024-0056" }
}

POST/api/order_out/delete

Vymazanie objednávky dodávateľovi. Vymazať možno iba otvorenú objednávku (status_id=1).

POST polia — objekt data

Pole	Typ	Povinné	Popis
`receipt_id`	int		Identifikátor objednávky, ktorá sa má vymazať

Príklad požiadavky

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

{ "data": { "receipt_id": 55 } }

POST/api/order_out/close

Uzavretie objednávky dodávateľovi. Uzavrieť možno iba otvorenú objednávku (status_id=1).

POST polia — objekt data

Pole	Typ	Povinné	Popis
`receipt_id`	int		Identifikátor objednávky, ktorá sa má uzavrieť

Príklad požiadavky

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

{ "data": { "receipt_id": 55 } }

GET/api/order_out/download

Stiahnutie dokumentu objednávky dodávateľovi v rôznych formátoch.

Query parametre

Parameter	Typ	Popis
`receipt_id`	int	Identifikátor objednávky
`file_type`	string	`pdf`, `pdf-string`, `pdf-string-sample`, `stream`
`language`	string	Názov jazykového priečinka šablóny (napr. `hungarian`)
`template_id`	int	ID vlastnej tlačovej šablóny

Príklad požiadavky

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

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!

Registrácia