bimetricsEntwickler
Zuordnungen

Zuordnung aufheben

Als Markdown ansehen

Benötigte Berechtigung:matching:write(Belege und Zahlungen zuordnen)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
delete/api/match/{id}

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

Hebt eine veränderbare Zuordnung auf und berechnet betroffene Buchungen neu. expectedVersions aus delete-preview unverändert mitsenden; die Vorschau nennt dabei gelöschte Serienbelege. Festgeschriebene Buchungen bleiben geschützt. Eine Wiederholung mit gleichem Schlüssel hebt nichts erneut auf.

Benötigt einen Schlüssel mit der Berechtigung matching:write.

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

Pfadparameter

id*string

ID des Objekts in dieser Firma (UUID).

Formatuuid

Header-Parameter

Idempotency-Key*string

Stabiler 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.

Muster^[!-~]+$
Länge1 <= length <= 128

Request-Body

application/json

Versions of the match and every affected resource

TypeScript-Typen

Typ request body für TypeScript.

Versionsbedingung aus der unveränderten Löschvorschau.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/match/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "deletedSeriesDocumentIds": [],  "id": "e21b3d18-17ea-4318-810c-919ec0a94dcb",  "replayed": false}

Zuordnung lesen GET

Liefert die Zuordnung mit ihren Beleg- und Umsatzreferenzen und dem offenen Betrag. Benötigt einen Schlüssel mit der Berechtigung `read`.

Aufheben einer Zuordnung prüfen GET

Liefert die aktuellen Versionsbedingungen und IDs der Serienbelege, die beim Aufheben gelöscht würden. Verändert nichts. Prüfe die betroffenen Belege vor DELETE und sende expectedVersions unverändert. Benötigt einen Schlüssel mit der Berechtigung `read`.