Bizonylat szabály API

Automatizálási szabályok kezelése — bizonylat konverzió, készletkezelés és webhook küldés

Alap URL

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

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A bizonylat szabály egy automatizálási logikát ír le — pl. rendelés → szállítólevél konverzió, készletmozgás végrehajtás, webhook küldés vagy nyomtatás. A szabályok manuálisan vagy ütemezve futtathatók.

GET /api/receipt_rule/get

Egyetlen szabály lekérése azonosító alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintSzabály azonosítója

Példa kérés

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

Szabályok lapozható listája.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_conditionobjectSzűrési feltételek objektuma

Példa kérés

GET /api/receipt_rule/list?list_offset=0
X-API-KEY: {az_api_kulcsod}
POST /api/receipt_rule/save

Szabály létrehozása vagy módosítása. Új szabályhoz data[id] = 0.

POST mezők — data objektum (főbb mezők)

MezőTípusKötelezőLeírás
idint0 = új szabály, >0 = módosítás
receipt_rule_type_idintSzabály típus azonosítója
source_receipt_type_idintForrás bizonylat típus azonosítója
dest_receipt_type_idintCél bizonylat típus azonosítója (konverzióhoz)
dest_receipt_closeint1 = cél bizonylat automatikus lezárása
company_idintCég azonosítója
company_user_idintKiállító munkatárs azonosítója
receipt_cron_timestringCron ütemezési kifejezés
printer_device_idintNyomtató eszköz azonosítója (automatikus nyomtatáshoz)
webhook_urlstringWebhook URL (automatikus küldéshez)
webhook_headerstringWebhook fejléc (JSON string)
receipt_cron_limit_loopintMax feldolgozás ciklusonként (alapért.: 10)
receipt_cron_limit_fullintMax összesített feldolgozás (alapért.: 100)

Példa kérés

POST /api/receipt_rule/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "receipt_rule_type_id": 1,
    "source_receipt_type_id": 5,
    "dest_receipt_type_id": 15,
    "company_id": 1,
    "company_user_id": 2,
    "receipt_cron_time": "0 6 * * *"
  }
}
POST /api/receipt_rule/delete

Szabály törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő szabály azonosítója

Példa kérés

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

{ "data": { "id": 1 } }
POST /api/receipt_rule/run_rules

Összes aktív szabály futtatása az aktuális rendszer állapotra.

POST mezők — data objektum

MezőTípusKötelezőLeírás
dataobjectOpcionális szűrési paraméterek

Példa kérés

POST /api/receipt_rule/run_rules
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": {} }
POST /api/receipt_rule/run_rule

Egyetlen szabály manuális futtatása.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA futtatandó szabály azonosítója

Példa kérés

POST /api/receipt_rule/run_rule
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": { "id": 1 } }

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!