bimetricsEntwickler
Automatisierungen

Treffer fester Regeln vorab zählen

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

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

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.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Request-Body

application/json
  1. body

Die Regeln, deren Treffer gezählt werden.

rules?array<>|

Bis zu 50 Regeln in der Form von rules einer Automatisierung, gespeichert oder nicht.

Antworten

Erfolg.

application/json
  1. response

Die Treffer je Regel, in der Reihenfolge der Anfrage.

rules?array<>|

Ein Eintrag je Regel.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/agent-rule-group/preview" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "rules": [    {      "index": 0,      "matches": 3,      "samples": [        {          "documentId": "a129ef0a-da5d-4204-804c-764d751bca95",          "firstCategory": "office_supplies",          "invoiceDate": {            "day": 3,            "month": 11,            "year": 2026          },          "invoiceNumber": "PRO-2026-0042",          "kind": "receipt",          "locked": false,          "otherName": "Muster Werkstatt GmbH"        }      ]    }  ]}