Szállítólevél API

Kimenő szállítólevelek kezelése — lekérés, létrehozás, módosítás, lezárás és dokumentum letöltés

Alap URL

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

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

Egyetlen kimenő szállítólevél lekérése azonosító alapján, teljes részletekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA szállítólevél egyedi azonosítója

Példa kérés

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

Kimenő szállítólevelek 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_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/delivery_note_out/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}
POST /api/delivery_note_out/save

Kimenő szállítólevél létrehozása vagy módosítása. Új rekordhoz data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új szállítólevél, >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_idintPartner/vevő azonosítója
partner_shipping_idintPartner szállítási cím ID
date_performdateSzállítás dátuma (YYYY-MM-DD)
comment_topstringÜgyfelnek látható megjegyzés
comment_bottomstringBelső megjegyzés
jobnumber_idintMunkaszám 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
pricefloatNettó egységár
tax_idintÁFA kulcs azonosítója
store_idintRaktár azonosítója
removeint1 = tétel törlése módosításkor

Példa kérés

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

Kimenő szállítólevél törlése. Csak nyitott státuszú szállítólevél törölhető.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA törlendő szállítólevél azonosítója

Példa kérés

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

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

Kimenő szállítólevél lezárása. Csak nyitott (status_id=1) szállítólevél zárható le.

POST mezők — data objektum

MezőTípusKötelezőLeírás
receipt_idintA lezárandó szállítólevél azonosítója

Példa kérés

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

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

Kimenő szállítólevél dokumentumának letöltése különböző formátumokban.

Query paraméterek

ParaméterTípusKötelezőLeírás
receipt_idintA szállítólevél azonosítója
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringSablon nyelvi mappa neve
template_idintEgyedi nyomtatási sablon ID

Példa kérés

GET /api/delivery_note_out/download?receipt_id=22&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!