Bolti értékesítés API

Pénztárgép / bolti értékesítés bizonylatok kezelése — lekérés, mentés, lezárás és dokumentum letöltés

Alap URL

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

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

Egyetlen bolti értékesítési bizonylat lekérése azonosító alapján, teljes tétellistával.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA bizonylat egyedi azonosítója

Példa kérés

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

Bolti értékesítési bizonylatok lapozható listájának 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 bizonylatszámra (LIKE)
list_condition[company_name]stringSzűrés vevő 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/cash_register/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {az_api_kulcsod}
POST /api/cash_register/save

Bolti értékesítési bizonylat létrehozása vagy módosítása. Új bizonylathoz data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új bizonylat, >0 = módosítás
company_idintCég azonosítója
company_user_idintFelelős munkatárs ID
company_address_idintTelephely azonosítója
currency_idintPénznem azonosítója
paymod_idintFizetési mód azonosítója
partner_idintVevő partner azonosítója
date_performdateTeljesítés dátuma (YYYY-MM-DD)
comment_topstringMegjegyzés
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
pricefloatBruttó 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/cash_register/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,
    "paymod_id": 1,
    "item": [
      { "product_id": 5, "quantity": 2, "price": 3990, "tax_id": 2 }
    ]
  }
}
POST /api/cash_register/delete

Bolti értékesítési bizonylat törlése. Csak nyitott státuszú bizonylat törölhető.

POST mezők — data objektum

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

Példa kérés

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

{ "data": { "receipt_id": 101 } }
POST /api/cash_register/close

Bolti értékesítési bizonylat lezárása. Lezáráskor a készletmozgás és a pénzügyi bejegyzés megtörténik. Csak nyitott (status_id=1) bizonylat zárható le.

POST mezők — data objektum

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

Példa kérés

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

{ "data": { "receipt_id": 101 } }
GET /api/cash_register/download

Bolti értékesítési bizonylat dokumentumának letöltése különböző formátumokban (PDF, nyomtatható blokk).

Query paraméterek

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

Példa kérés

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