Položka dokladu API

Získavanie položiek dokladu, štatistika a stiahnutie — iba na čítanie

Základná URL

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

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Položka dokladu predstavuje riadok dokladu — produkt, množstvo, cenu a skladové údaje. Tento koncový bod je iba na čítanie: na úpravu položiek je potrebné použiť API príslušného typu dokladu.

GET /api/receipt_item/get

Získanie jednej položky dokladu.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor položky
receipt_idintIdentifikátor dokladu
receipt_type_idintIdentifikátor typu dokladu
product_idintIdentifikátor produktu
comment_topstringFilter podľa poznámky k položke

Príklad požiadavky

GET /api/receipt_item/get?receipt_id=150&receipt_type_id=8
X-API-KEY: {vas_api_kluc}
GET /api/receipt_item/get_extended

Získanie rozšírených údajov položky (s údajmi o partnerovi, firme, DPH a sklade).

Rovnaké parametre ako pri koncovom bode /get, ale s bohatšími údajmi vo výstupe.

GET /api/receipt_item/list

Zoznam položiek jedného dokladu.

Query parametre

ParameterTypPovinnéPopis
receipt_idintIdentifikátor dokladu
receipt_type_idintIdentifikátor typu dokladu

Príklad požiadavky

GET /api/receipt_item/list?receipt_id=150&receipt_type_id=8
X-API-KEY: {vas_api_kluc}
GET /api/receipt_item/list_light

Odľahčený zoznam položiek — s možnosťou filtrovania a stránkovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt s filtrovacími podmienkami

Príklad požiadavky

GET /api/receipt_item/list_light?list_condition[receipt_type_id]=8&list_offset=0
X-API-KEY: {vas_api_kluc}
GET /api/receipt_item/list_slim

Položky s minimálnym rozsahom údajov (slim) — pre rýchlu synchronizáciu.

Rovnaké parametre ako pri koncovom bode /list_light.

GET /api/receipt_item/list_group

Súhrnný skupinový zoznam položiek na úrovni produktu.

Rovnaké parametre ako pri koncovom bode /list_light.

GET /api/receipt_item/list_barcodes

Položky doplnené o údaje o čiarových kódoch.

Rovnaké parametre ako pri koncovom bode /list_light.

GET /api/receipt_item/list_tax

Získanie súhrnu DPH dokladu podľa položiek.

Rovnaké parametre ako pri koncovom bode /list_light.

GET /api/receipt_item/list_store_locality

Položky doplnené o údaje o skladovej lokalite.

Rovnaké parametre ako pri koncovom bode /list_light.

GET /api/receipt_item/statistic

Súhrnná štatistika položiek.

Príklad požiadavky

GET /api/receipt_item/statistic
X-API-KEY: {vas_api_kluc}
GET /api/receipt_item/download

Stiahnutie položky dokladu vo formáte PDF/inom formáte.

Query parametre

ParameterTypPovinnéPopis
file_typestringFormát stiahnutia (napr. pdf, return-base64)
receipt_idintIdentifikátor dokladu
receipt_type_idintIdentifikátor typu dokladu
languagestringKód jazyka (napr. hu, en)
language_idintIdentifikátor jazyka prekladu
template_idintIdentifikátor šablóny
receipt_item_idintIdentifikátor konkrétnej položky (voliteľný filter)

Príklad požiadavky

GET /api/receipt_item/download?file_type=return-base64&receipt_id=150&receipt_type_id=8&language_id=1
X-API-KEY: {vas_api_kluc}

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!