Basis-URL
https://{tenant}.logzi.com/api/receipt_rule/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Eine Belegregel beschreibt eine Automatisierungslogik — z. B. Konvertierung von Bestellung → Lieferschein, Ausführung einer Bestandsbewegung, Webhook-Versand oder Druck. Die Regeln können manuell oder zeitgesteuert ausgeführt werden.
/api/receipt_rule/get
Abrufen einer einzelnen Regel anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der Regel |
Beispielanfrage
GET /api/receipt_rule/get?id=1
X-API-KEY: {ihr_api_schluessel}/api/receipt_rule/list
Paginierbare Liste der Regeln.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Offset der Paginierung (Standard: 0) | |
list_condition | object | Objekt der Filterbedingungen |
Beispielanfrage
GET /api/receipt_rule/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/receipt_rule/save
Erstellen oder Ändern einer Regel. Für eine neue Regel data[id] = 0.
POST-Felder — data-Objekt (Hauptfelder)
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue Regel, >0 = Änderung | |
receipt_rule_type_id | int | ID des Regeltyps | |
source_receipt_type_id | int | ID des Quellbeleg-Typs | |
dest_receipt_type_id | int | ID des Zielbeleg-Typs (für Konvertierung) | |
dest_receipt_close | int | 1 = automatischer Abschluss des Zielbelegs | |
company_id | int | Firmen-ID | |
company_user_id | int | ID des ausstellenden Mitarbeiters | |
receipt_cron_time | string | Cron-Zeitplanausdruck | |
printer_device_id | int | ID des Druckergeräts (für automatischen Druck) | |
webhook_url | string | Webhook-URL (für automatischen Versand) | |
webhook_header | string | Webhook-Header (JSON-String) | |
receipt_cron_limit_loop | int | Max. Verarbeitung pro Zyklus (Standard: 10) | |
receipt_cron_limit_full | int | Max. Gesamtverarbeitung (Standard: 100) |
Beispielanfrage
POST /api/receipt_rule/save
X-API-KEY: {ihr_api_schluessel}
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 * * *"
}
}/api/receipt_rule/delete
Löschen einer Regel anhand der ID.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der zu löschenden Regel |
Beispielanfrage
POST /api/receipt_rule/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 1 } }/api/receipt_rule/run_rules
Ausführen aller aktiven Regeln auf den aktuellen Systemzustand.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
data | object | Optionale Filterparameter |
Beispielanfrage
POST /api/receipt_rule/run_rules
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": {} }/api/receipt_rule/run_rule
Manuelles Ausführen einer einzelnen Regel.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der auszuführenden Regel |
Beispielanfrage
POST /api/receipt_rule/run_rule
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 1 } }Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
