Registrácia Prihlásenie

API pravidiel dokladov

Správa automatizačných pravidiel — konverzia dokladov, správa zásob a odosielanie webhookov

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/receipt_rule/

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi platí result.code == 1, pri chybe result.code == 0. Pravidlo dokladu popisuje automatizačnú logiku — napr. konverziu objednávky na dodací list, vykonanie pohybu zásob, odoslanie webhooku alebo tlač. Pravidlá je možné spúšťať manuálne alebo podľa harmonogramu.

GET /api/receipt_rule/get

Získanie jedného pravidla podľa identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor pravidla

Príklad požiadavky

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

Stránkovateľný zoznam pravidiel.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt filtrovacích podmienok

Príklad požiadavky

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

Vytvorenie alebo úprava pravidla. Pre nové pravidlo data[id] = 0.

POST polia — objekt data (hlavné polia)

PoleTypPovinnéPopis
idint0 = nové pravidlo, >0 = úprava
receipt_rule_type_idintIdentifikátor typu pravidla
source_receipt_type_idintIdentifikátor typu zdrojového dokladu
dest_receipt_type_idintIdentifikátor typu cieľového dokladu (pre konverziu)
dest_receipt_closeint1 = automatické uzavretie cieľového dokladu
company_idintIdentifikátor firmy
company_user_idintIdentifikátor vystavujúceho zamestnanca
receipt_cron_timestringCron výraz plánovania
printer_device_idintIdentifikátor tlačového zariadenia (pre automatickú tlač)
webhook_urlstringWebhook URL (pre automatické odosielanie)
webhook_headerstringWebhook hlavička (reťazec JSON)
receipt_cron_limit_loopintMax. spracovanie na cyklus (predvolené: 10)
receipt_cron_limit_fullintMax. celkové spracovanie (predvolené: 100)

Príklad požiadavky

POST /api/receipt_rule/save
X-API-KEY: {vas_api_kluc}
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

Vymazanie pravidla podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor pravidla, ktoré sa má vymazať

Príklad požiadavky

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

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

Spustenie všetkých aktívnych pravidiel na aktuálny stav systému.

POST polia — objekt data

PoleTypPovinnéPopis
dataobjectVoliteľné filtrovacie parametre

Príklad požiadavky

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

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

Manuálne spustenie jedného pravidla.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor pravidla, ktoré sa má spustiť

Príklad požiadavky

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

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

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