Automatisierung löschen
Benötigte Berechtigung:automations:write
Echte Wirkung
/api/agent-rule-group/{id}Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.
Löscht eine Automatisierung wie in der App; das Änderungsprotokoll behält sie. Belege, die ihre Regeln schon geändert haben, bleiben, wie sie sind. Wer sie nur pausieren will, schickt sie mit PUT so, wie er sie gelesen hat, mit active: false. Bei einer Wiederholung schickst du denselben Idempotency-Key.
Benötigt einen Schlüssel mit der Berechtigung automations:write.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
id*stringID der Automatisierung in dieser Firma (UUID).
uuidIdempotency-Key*stringStabiler Schlüssel für genau diese Änderung: 1–128 druckbare ASCII-Zeichen ohne Leerzeichen. Bei Wiederholungen denselben Schlüssel und unveränderten Inhalt senden; das Ergebnis wird nicht nochmals erzeugt.
^[!-~]+$1 <= length <= 128Erfolg.
application/json- response
Eine Automatisierung mit ihren Regeln.
active?booleantrue: Ihre Regeln wirken auf neue Uploads und Korrekturen.
companyId?stringID der Firma.
uuidcreatedAt?stringZeitpunkt des Anlegens.
date-timedisplayName?stringName der Automatisierung.
id?stringID der Automatisierung.
uuidrules?array<>|Die Regeln der Automatisierung.
updatedAt?stringZeitpunkt der letzten Änderung; beim Ändern als expectedUpdatedAt zurückschicken.
date-timecurl --fail-with-body "https://app.bimetrics.de/api/agent-rule-group/497f6eca-6276-4993-bfeb-53cbbbba6f08" -X DELETE \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Idempotency-Key: rechnung-2026-001"{ "active": true, "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5", "createdAt": "2026-11-20T09:00:00Z", "displayName": "Eigene Rechnungen", "id": "3f6a9d21-4c8e-4b7a-9e15-8d2c7b4a1f60", "rules": [ { "active": true, "id": "a81c5e3d-92f4-4d6b-b07e-5c3f1a9e2d47", "instructions": "", "isOverride": false, "match": { "invoiceNumberPrefixes": [ "PRO-2026" ], "mode": "any", "ownCompany": true }, "name": "Eigene Rechnungen sind Ausgang", "priority": 1, "scope": "categorization", "setKind": "invoice", "targetCategory": "sales_income", "triggerWords": [], "weight": 85 } ], "updatedAt": "2026-11-20T09:00:00Z"}Automatisierung lesen GET
Liefert eine Automatisierung mit ihren Regeln. `updatedAt` schickst du beim Ändern als `expectedUpdatedAt` zurück. Benötigt einen Schlüssel mit der Berechtigung `automations:read`.
Automatisierung ändern oder schalten PUT
Ersetzt Name, `active` und alle Regeln; eine Regel, die fehlt, entfällt. Zum Ausschalten schick die Automatisierung so, wie du sie gelesen hast, mit `active: false`; zum Einschalten ebenso mit `active: true`. `expectedUpdatedAt` ist das gelesene `updatedAt` und Pflicht; hat sich die Automatisierung seitdem geändert, antwortet die Route mit `409 VersionConflict` und ändert nichts. Eine feste Regel braucht mindestens eine Bedingung und eine Kategorie (`targetCategory`), `mode` ist `all` oder `any`. `setKind` geht nur zusammen mit einer Kategorie, die zu diesem Belegtyp passt. Kategorien, die bimetrics nur selbst setzt oder die es nur für Buchungen ohne Beleg gibt, lässt eine feste Regel nicht zu. Prüft sie den Belegtyp (`match.kind`), ohne ihn zu setzen, muss die Kategorie zu diesem Belegtyp passen. Bereits gespeicherte Regeln mit derselben `id` bleiben erlaubt, solange `targetCategory`, `setKind` und `match.kind` unverändert sind. Verstößt eine Regel dagegen, antwortet die Route mit `400`, `context.field` nennt das Feld (etwa `rules[0].targetCategory`) und `detail` den Satz der App; gespeichert wird nichts. Höchstens 100 Automatisierungen sind gleichzeitig aktiv, eine weitere aktive ergibt `409 AgentRuleGroupActiveLimit`. Jede Regel bekommt eine `id`; schick sie beim Ändern mit, damit ihre Treffer bei ihr bleiben. Bei einer Wiederholung schickst du denselben Idempotency-Key. Benötigt einen Schlüssel mit der Berechtigung `automations:write`.