Registrácia Prihlásenie

Dodací list API

Správa výdajových dodacích listov — získanie, vytvorenie, úprava, uzavretie a stiahnutie dokumentu

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/delivery_note_out/

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

GET /api/delivery_note_out/get

Získanie jedného výdajového dodacieho listu na základe identifikátora, s úplnými podrobnosťami.

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor dodacieho listu

Príklad požiadavky

GET /api/delivery_note_out/get?id=22
X-API-KEY: {vas_api_kluc}
GET /api/delivery_note_out/list

Stránkovateľné získanie zoznamu výdajových dodacích listov s možnosťou filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_countintPočet záznamov na stránku
list_condition[identify]stringFiltrovanie podľa identifikátora (LIKE)
list_condition[company_name]stringFiltrovanie podľa názvu partnera (LIKE)
list_condition[status_id]intFiltrovanie podľa stavu
list_condition[date_create_from]dateDátum vytvorenia — od (YYYY-MM-DD)
list_condition[date_create_to]dateDátum vytvorenia — do (YYYY-MM-DD)

Príklad požiadavky

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

Vytvorenie alebo úprava výdajového dodacieho listu. Pre nový záznam data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový dodací list, >0 = úprava
company_idintIdentifikátor firmy
company_user_idintID zodpovedného zamestnanca
company_address_idintID prevádzky firmy
currency_idintIdentifikátor meny
partner_idintIdentifikátor partnera/odberateľa
partner_shipping_idintID dodacej adresy partnera
date_performdateDátum dodania (YYYY-MM-DD)
comment_topstringPoznámka viditeľná pre zákazníka
comment_bottomstringInterná poznámka
jobnumber_idintIdentifikátor zákazky
itemarrayPole položiek (pozri nižšie)

Polia položky — data[item][]

PoleTypPovinnéPopis
product_idintIdentifikátor produktu
quantityfloatMnožstvo
pricefloatJednotková cena netto
tax_idintIdentifikátor sadzby DPH
store_idintIdentifikátor skladu
removeint1 = vymazanie položky pri úprave

Príklad požiadavky

POST /api/delivery_note_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": 12,
    "date_perform": "2024-06-20",
    "item": [
      { "product_id": 5, "quantity": 3, "price": 12000, "tax_id": 2 }
    ]
  }
}
POST /api/delivery_note_out/delete

Vymazanie výdajového dodacieho listu. Vymazať možno len dodací list v otvorenom stave.

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor dodacieho listu určeného na vymazanie

Príklad požiadavky

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

{ "data": { "receipt_id": 22 } }
POST /api/delivery_note_out/close

Uzavretie výdajového dodacieho listu. Uzavrieť možno len dodací list v otvorenom stave (status_id=1).

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor dodacieho listu určeného na uzavretie

Príklad požiadavky

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

{ "data": { "receipt_id": 22 } }
GET /api/delivery_note_out/download

Stiahnutie dokumentu výdajového dodacieho listu v rôznych formátoch.

Query parametre

ParameterTypPovinnéPopis
receipt_idintIdentifikátor dodacieho listu
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringNázov jazykového priečinka šablóny
template_idintID vlastnej tlačovej šablóny

Príklad požiadavky

GET /api/delivery_note_out/download?receipt_id=22&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!
Vytvorenie registrácie
Registrácia