Základná URL
https://{tenant}.logzi.com/api/offer_send/
Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API na odosielanie ponúk umožňuje evidenciu, uzatváranie a sťahovanie odoslaných ponúk zákazníkom vo formáte PDF.
/api/offer_send/get
Načítanie jedného dokladu odoslanej ponuky podľa identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor dokladu |
Príklad požiadavky
GET /api/offer_send/get?id=1
X-API-KEY: {vas_api_kluc}
/api/offer_send/list
Stránkovateľný zoznam odoslaných ponúk.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_count | int | Maximálny počet vrátených záznamov | |
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt s filtračnými podmienkami | |
list_sort | object | Objekt s podmienkami zoradenia |
Príklad požiadavky
GET /api/offer_send/list?list_offset=0&list_count=50
X-API-KEY: {vas_api_kluc}
/api/offer_send/download
Stiahnutie dokladu odoslanej ponuky vo formáte PDF alebo inom formáte.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
file_type | string | Typ súboru (napr. pdf) | |
receipt_id | int | Identifikátor dokladu | |
language | string | Jazyk dokladu (napr. hu) | |
language_id | int | Identifikátor jazyka | |
template_id | int | Identifikátor tlačovej šablóny |
Príklad požiadavky
GET /api/offer_send/download?file_type=pdf&receipt_id=1&language=hu
X-API-KEY: {vas_api_kluc}
/api/offer_send/close
Uzavretie odoslanej ponuky.
POST polia — objekt data
V objekte data je potrebné uviesť identifikátor dokladu, ktorý sa má uzavrieť.
Príklad požiadavky
POST /api/offer_send/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/offer_send/delete
Odstránenie dokladu odoslanej ponuky.
POST polia — objekt data
V objekte data je potrebné uviesť údaje dokladu, ktorý sa má odstrániť.
Príklad požiadavky
POST /api/offer_send/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
Zaregistruj sa teraz,
zaplať neskôr!