Szállítói ajánlatkérés API

Szállítók felé irányuló ajánlatkérések kezelése — lekérés, létrehozás, módosítás és lezárás

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/offer_request/get

Egyetlen szállítói ajánlatkérés lekérése azonosító alapján, teljes részletekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintAz ajánlatkérés egyedi azonosítója

Példa kérés

GET /api/offer_request/get?id=15
X-API-KEY: {az_api_kulcsod}

Példa válasz

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

Szállítói ajánlatkérések listájának lapozható lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_countintOldalanként megjelenő rekordok száma
list_sort[field]stringRendezési mező neve
list_sort[sort]stringRendezés iránya: ASC vagy DESC
list_condition[identify]stringSzűrés azonosítóra (LIKE)
list_condition[company_name]stringSzűrés partner nevére (LIKE)
list_condition[status_id]intSzűrés státuszra
list_condition[date_create_from]dateLétrehozás dátuma — tól (YYYY-MM-DD)
list_condition[date_create_to]dateLétrehozás dátuma — ig (YYYY-MM-DD)

Példa kérés

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

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    { "id": 15, "identify": "AK-2024-0015", "partner_company_name": "Minta Szállító Kft.", "status_id": 1, "price_brutto": 101600 }
  ],
  "params": { "list_count": 20, "list_offset": 0, "list_all": 42 }
}
POST /api/offer_request/save

Szállítói ajánlatkérés létrehozása vagy módosítása. Új rekordhoz data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új ajánlatkérés, >0 = módosítás
company_idintCég azonosítója
company_user_idintFelelős munkatárs ID
company_address_idintCég telephely ID
currency_idintPénznem azonosítója
partner_idintSzállító partner azonosítója
date_performdateHatáridő dátuma (YYYY-MM-DD)
comment_topstringSzállítónak látható megjegyzés
comment_bottomstringBelső megjegyzés
jobnumber_idintMunkaszám azonosítója
project_idintProjekt azonosítója
itemarrayTételek tömbje (ld. alább)

Tétel mezők — data[item][]

MezőTípusKötelezőLeírás
product_idintTermék azonosítója
quantityfloatMennyiség
pricefloatTájékoztató nettó egységár
tax_idintÁFA kulcs azonosítója
price_discountfloatKedvezmény százaléka
removeint1 = tétel törlése módosításkor

POST mezők — params objektum (opcionális)

MezőTípusKötelezőLeírás
closeint1 = mentés után automatikus lezárás
downloadint1 = mentés után PDF generálás

Példa kérés

POST /api/offer_request/save
X-API-KEY: {az_api_kulcsod}
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": "Kérjük az ajánlatot 15 napon belül visszaküldeni.",
    "item": [
      { "product_id": 5, "quantity": 10, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

Példa válasz

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

Szállítói ajánlatkérés törlése. Csak nyitott (status_id=1) rekord törölhető.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA törlendő ajánlatkérés azonosítója

Példa kérés

POST /api/offer_request/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

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

Példa válasz

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

Nyitott szállítói ajánlatkérés lezárása. Csak status_id = 1 (nyitott) rekord zárható le.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA lezárandó ajánlatkérés azonosítója

Példa kérés

POST /api/offer_request/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

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

Példa válasz

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

Szállítói ajánlatkérés dokumentumának letöltése különböző formátumokban.

Query paraméterek

ParaméterTípusKötelezőLeírás
receipt_idintAz ajánlatkérés azonosítója
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringSablon nyelvi mappa neve (pl. hungarian)
template_idintEgyedi nyomtatási sablon ID

Példa kérés

GET /api/offer_request/download?receipt_id=15&file_type=pdf
X-API-KEY: {az_api_kulcsod}

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!