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. Sind Buchungen schon an DATEV exportiert (exportedMonths der Vorschau), hebt bimetrics die Zuordnung nur mit confirmExported: true auf, sonst kommt 409 FinalizedBookingsLocked. Es bucht dann dasselbe wie „Zuordnung lösen“ in der App. Festgeschriebene Buchungen bleiben stehen, ob exportiert oder nicht. Storno und Neubuchung bucht bimetrics nur dort, wo sich für DATEV etwas ändert: bei einer festgeschriebenen Zahlung immer, weil ihr Konto wechselt, und bei einer Sammelzahlung mit Rest auch bei den Belegen. Was davon schon exportiert war, geht mit dem nächsten Export der noch nicht exportierten Buchungen als Nachtrag an DATEV. Ist die Umsatzsteuer-Voranmeldung eines Monats aus reversedFinalizedMonths schon abgegeben, kann eine Berichtigung nötig sein. Neu zuordnen lassen sich Beleg und Umsatz danach mit POST /api/match/ und confirmExported: true. Eine Wiederholung mit gleichem Schlüssel hebt nichts erneut auf.

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

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

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

Versionen der Zuordnung und aller betroffenen Objekte

application/json
  1. body

Versionsbedingung aus der unveränderten Löschvorschau.

confirmExported?boolean

true nur, nachdem der Nutzer die Monate aus exportedMonths der Vorschau gesehen und bestätigt hat. Dann hebt bimetrics auch eine Zuordnung auf, deren Buchungen schon an DATEV exportiert sind. Ohne das Feld kommt für sie 409 FinalizedBookingsLocked.

expectedVersions?|

Vollständige Versionsmap aus GET /api/match/:id/delete-preview.

Antworten

Erfolg.

application/json
  1. response

Ergebnis der aufgehobenen Zuordnung.

deletedSeriesDocumentIds?array<>|

IDs dabei entfernter, aus Vorlagen erzeugter Belege.

exportedMonths?array<string>

Nur mit confirmExported: die Monate mit Buchungen, die schon an DATEV exportiert waren. Beleg und Umsatz ordnet POST /api/match/ dann ebenfalls nur mit confirmExported: true neu zu.

id?string

ID der aufgehobenen Zuordnung.

Formatuuid
replayed?boolean

True bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs.

reversedFinalizedMonths?array<string>

Monate (YYYY-MM), in denen bimetrics festgeschriebene Buchungen storniert und mit geändertem Datum, Leistungszeitraum, Konto, Steuerkennzeichen oder Betrag neu gebucht hat. Ändert sich nur der Buchungstext oder die Zuordnung, fehlt der Monat. Hast du die Umsatzsteuer-Voranmeldung für einen dieser Monate oder, bei geändertem Datum, für den neuen Monat schon abgegeben, musst du sie womöglich berichtigen. Fehlt, wenn nichts storniert wurde, und bei einer Wiederholung mit demselben Idempotency-Key.

Beispielanfrage
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 '{}'
Beispielantwort
{  "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`.

Offenen Betrag einer Zuordnung als Skonto ausgleichen POST

Gleicht den offenen Betrag einer Zuordnung als Skonto aus, wie „als Skonto ausgleichen“ in der App, ohne sie vorher aufzuheben. Eine Differenz allein beweist kein Skonto: Rufe das erst auf, wenn der Nutzer die Werte aus `previewMatchCashDiscount` bestätigt hat. bimetrics ersetzt die Zuordnung in einem Schritt durch eine neue über dieselben Belege und denselben Umsatz und bucht das Skonto wie beim ersten Zuordnen, bei 19 % und 7 % mit anteiliger Korrektur der Umsatzsteuer, bei § 13b UStG netto ohne Umsatzsteuer; `replacedMatchId` nennt die alte. Belegbetrag und Steuerangaben bleiben, der offene Betrag ist danach null. `expectedVersions` kommt unverändert aus `previewMatchCashDiscount`. Eine Wiederholung mit gleichem Schlüssel bucht nichts erneut. Nicht möglich, wenn die Zuordnung nicht passt oder schon mit Skonto oder einer Kursdifferenz ausgeglichen ist (`400 CashDiscountNotEligible`), bei einem Beleg in Fremdwährung, dessen Euro-Betrag noch fehlt (`400 CashDiscountForeignCurrency`), und wenn Buchungen schon an DATEV exportiert sind (`409 FinalizedBookingsLocked`). Andere festgeschriebene Buchungen bleiben stehen; storniert und neu gebucht werden sie nur, wenn sich für DATEV etwas ändert. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.