bimetricsEntwickler
Automatisierungen

Automatisierungen suchen

Als Markdown ansehen

Benötigte Berechtigung:automations:read

Echte Wirkung

Dieser Aufruf ist nicht als rein lesend gekennzeichnet und kann echte Daten in der Firma anlegen oder ändern. Es gibt keine Testumgebung.
post/api/agent-rule-group/filter

Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.

Sucht die Automatisierungen der Firma mit ihren Regeln, aktive und ausgeschaltete. Gelöschte fehlen, auch mit includeDeleted.

Benötigt einen Schlüssel mit der Berechtigung automations:read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Request-Body

Filter, Sortierung und Seite. Dokumentierte Filterattribute: x-bimetrics-filter.

application/json
  1. body

Suche mit Filter, Sortierung und Paginierung. Der Filterausdruck steht auf oberster Ebene; {} liefert alle Einträge. Bei Anfragen mit API-Schlüssel antwortet die API mit 400 auf unbekannte Felder (etwa filter, from oder to), Parameter in der URL, einen Ausdruck ohne kind (etwa nur attribute und value) und direction desc ohne sort; context.fields nennt die Angaben.

attribute?string

Filterattribut für eq, in, range und oneof, siehe x-bimetrics-filter der Operation. Groß-/Kleinschreibung und Punkte werden ignoriert.

children?array<>

Teilfilter für and, or und not.

direction?|array<>

Richtung je Eintrag in sort; Standard asc.

includeDeleted?boolean

true liefert auch gelöschte Einträge, erkennbar an deletedAt, aber nur bei Belegen, Kontakten, Bankkonten, Umsätzen und Buchungen; die übrigen Suchrouten ignorieren das Feld. Ohne das Feld oder mit false nur Einträge, die nicht gelöscht sind. Für Abgleiche von Löschungen mit range auf deletedAt, siehe Delta-Sync.

Standardfalse
kind?string

Art des Filters: and/or verknüpfen children, not verneint children, eq vergleicht attribute mit value (null prüft auf leer), in sucht value als Text im Attribut (enthält, ohne Groß-/Kleinschreibung), range prüft lower ≤ Attribut ≤ upper (eine Grenze genügt), oneof prüft, ob das Attribut einem Wert der Liste value entspricht. Leer: alle Einträge.

Wert in"""and""or""eq""not""in""range""oneof"
limit?integer

Treffer je Seite. Standard und Höchstwert 1000; größere Werte werden auf 1000 begrenzt.

Bereich0 <= value
Standard1000
lower?unknown

Untergrenze für range, einschließlich.

offset?integer

Anzahl übersprungener Treffer. Haben Einträge in den Sortierfeldern denselben Wert, entscheidet zuletzt id; ohne sort kommen sie in der Reihenfolge, in der sie angelegt wurden. Kommt mit sort zwischen zwei Abrufen ein Eintrag dazu, kann ein Eintrag zweimal kommen; Doppelte erkennst du an der id, ein Abgleich mit Überlappung (Delta-Sync) hilft ebenso.

Bereich0 <= value <= 1000000
Standard0
sort?|array<string>

Attribute, nach denen sortiert wird; nur sortierbare Attribute (sortable in x-bimetrics-filter). Ein Attribut mit sortable: false ergibt 400.

upper?unknown

Obergrenze für range, einschließlich.

value?unknown

Vergleichswert: für eq ein Wert oder null, für in ein Text, für oneof eine Liste.

Filterattribute

Dokumentiert sind diese Attribute für attribute; für sort nur die als sortierbar markierten. Aufbau des Filters: Filtern und Paginieren.

AttributTypSortierbarBeschreibung
iduuidjaID der Automatisierung.
displayNamestringjaName der Automatisierung.
activebooleanja`true` für aktive Automatisierungen.
createdAtdate-timejaZeitpunkt des Anlegens.
updatedAtdate-timejaZeitpunkt der letzten Änderung.

Antworten

Eine Seite der Treffer.

application/json
  1. response

Eine Seite gefundener Automatisierungen.

items?array<>|

Die Treffer dieser Seite.

limit?|

Verwendetes limit.

offset?integer

Verwendetes offset.

total?integer

Anzahl aller Treffer des Filters.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/agent-rule-group/filter" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{"direction":["desc","asc"],"limit":100,"offset":0,"sort":["updatedAt","id"]}'
Beispielantwort
{  "items": [    {      "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"    }  ],  "limit": 100,  "offset": 0,  "total": 1}

Automatisierung anlegen POST

Legt eine Automatisierung mit ihren Regeln an, wie das Formular der App. Feste Regeln greifen ab jetzt beim Upload und nach Korrekturen; vorhandene Belege bleiben, wie sie sind. 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`.

Treffer fester Regeln vorab zählen POST

Zählt je Regel die nicht gelöschten Belege der letzten 12 Monate, die eine feste Regel trifft, und nennt bis zu 5 davon, wie die Vorschau im Formular der App. Die Regeln dürfen ungespeichert und unvollständig sein; gezählt wird mit derselben Prüfung, die die Regel später anwendet. `locked` markiert Belege, die die Regel nie ändern würde. Bei einer freien Regel ist `matches` `null`: Wo sie passt, entscheidet erst die Erkennung. Die Vorschau ändert nichts, und auch das Speichern ändert vorhandene Belege nicht. Mehr als 50 Regeln ergeben `400 BulkLimitExceeded`. Benötigt einen Schlüssel mit der Berechtigung `automations:read`.