Registrácia Prihlásenie

API odosielania ponuky zákazníkovi

Správa odchádzajúcich ponúk pre zákazníkov — 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/offer_send/

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

GET /api/offer_send/get

Získanie jednej ponuky pre zákazníka na základe identifikátora, so všetkými podrobnosťami.

Query parametre

ParameterTypPovinnéPopis
idintJedinečný identifikátor ponuky

Príklad požiadavky

GET /api/offer_send/get?id=15
X-API-KEY: {vas_api_kluc}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 15,
    "identify": "AJ-2024-0015",
    "date_create": "2024-05-01 09:00:00",
    "date_perform": "2024-05-15",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_netto": 80000,
    "price_brutto": 101600,
    "currency_name": "HUF",
    "item": [
      { "product_id": 3, "quantity": 2, "price": 40000, "tax_id": 2 }
    ]
  }
}
GET /api/offer_send/list

Stránkovateľné získanie zoznamu ponúk pre zákazníkov s možnosťami filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolene: 0)
list_countintPočet záznamov zobrazených na stránku
list_sort[field]stringNázov poľa na zoradenie
list_sort[sort]stringSmer zoradenia: ASC alebo DESC
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/offer_send/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": 15, "identify": "AJ-2024-0015", "partner_company_name": "Minta Kft.", "status_id": 1, "price_brutto": 101600 }
  ],
  "params": { "list_count": 20, "list_offset": 0, "list_all": 42 }
}
POST /api/offer_send/save

Vytvorenie alebo úprava ponuky pre zákazníka. Pre novú ponuku zadajte data[id] = 0, pre úpravu zadajte existujúce ID.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nová ponuka, >0 = úprava
company_idintIdentifikátor firmy
company_user_idintID zodpovedného pracovníka
company_address_idintID prevádzky firmy
currency_idintIdentifikátor meny
partner_idintIdentifikátor partnera/zákazníka
date_performdateDátum platnosti (YYYY-MM-DD)
comment_topstringPoznámka viditeľná pre zákazníka
comment_bottomstringInterná poznámka
jobnumber_idintIdentifikátor zákazky
project_idintIdentifikátor projektu
itemarrayPole položiek (pozri nižšie)

Polia položky — data[item][]

PoleTypPovinnéPopis
product_idintIdentifikátor produktu
quantityfloatMnožstvo
pricefloatJednotková cena bez DPH
tax_idintIdentifikátor sadzby DPH
price_discountfloatPercento zľavy
removeint1 = vymazanie položky pri úprave

POST polia — objekt params (voliteľné)

PoleTypPovinnéPopis
closeint1 = automatické uzavretie po uložení
downloadint1 = vygenerovanie PDF po uložení

Príklad požiadavky

POST /api/offer_send/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-30",
    "comment_top": "Az ajánlat 30 napig érvényes.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

Príklad odpovede

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 16, "identify": "AJ-2024-0016" }
}
POST /api/offer_send/delete

Vymazanie ponuky pre zákazníka. Vymazať možno iba otvorenú ponuku (status_id=1).

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor ponuky, ktorá sa má vymazať

Príklad požiadavky

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

{ "data": { "receipt_id": 15 } }

Príklad odpovede

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

Uzavretie otvorenej ponuky pre zákazníka. Uzavrieť možno iba ponuku so status_id = 1 (otvorená).

POST polia — objekt data

PoleTypPovinnéPopis
receipt_idintIdentifikátor ponuky, ktorá sa má uzavrieť

Príklad požiadavky

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

{ "data": { "receipt_id": 15 } }

Príklad odpovede

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

Stiahnutie dokumentu ponuky pre zákazníka v rôznych formátoch.

Query parametre

ParameterTypPovinnéPopis
receipt_idintIdentifikátor ponuky
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringNázov jazykového priečinka šablóny (napr. hungarian)
template_idintID vlastnej tlačovej šablóny

Príklad požiadavky

GET /api/offer_send/download?receipt_id=15&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