bimetricsEntwickler
Zuordnungen

Erfasste Zahlung zurücknehmen

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.
post/api/match/payment/reverse

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

Nimmt eine erfasste Bar-, Verrechnungs- oder Privatzahlung oder eine Rundungsdifferenz oder Ausbuchung durch Gegenbuchung zurück; solange eine davon aktiv ist, geht sie vor jeder anderen Zahlung des Belegs zurück (409 RoundingStillActive, 409 WriteOffStillActive). Die ursprüngliche Zahlung und Buchung bleiben in der Historie. Erwartet aktuelle Belegversion und offenen Betrag; auch bei ausgeschalteter Neuerfassung verfügbar.

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.

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

Rücknahme einer Zahlung

application/json
  1. body

Rücknahme einer erfassten Zahlung durch Gegenbuchung.

expectedAmountOpenMinor?|

Aktueller offener Betrag des Belegs in Cent.

expectedVersion?string

Aktueller fachlicher Versionsdigest des Belegs.

paymentId?string

ID der zurückzunehmenden Zahlung.

Formatuuid
reversedOn?

Datum der Gegenbuchung, frühestens der Zahltag, höchstens heute. Ohne Angabe der Zahltag, solange dessen Buchung offen ist, sonst heute. Bei einer Ausbuchung (write_off) Pflicht: der Tag der Zahlung, wenn der Kunde doch zahlt, nach einem Irrtum der Tag der Ausbuchung.

Antworten

Erfolg.

application/json
  1. response

Erfasste Zahlung und neuer offener Betrag.

amountOpenMinor?integer

Verbleibender offener Betrag in Cent; solange beim Beleg der Euro-Betrag fehlt, in Hundertsteln der Belegwährung.

amountOpenOriginalMinor?integer

Nur bei einer Zahlung in Belegwährung: was vom Beleg in seiner Währung noch offen ist, in Hundertsteln.

payment?|

Dokumentierte Zahlung.

replayed?boolean

True bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/match/payment/reverse" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "amountOpenMinor": 11900,  "payment": {    "account": 1000,    "accountContra": 71007,    "amountMinor": 5950,    "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",    "createdAt": "2026-09-02T10:00:00Z",    "currency": "EUR",    "documentId": "a129ef0a-da5d-4204-804c-764d751bca95",    "id": "d5e264b8-4c4a-4155-a71a-c0bd9d9c757f",    "method": "cash",    "origin": "api",    "paidOn": {      "day": 2,      "month": 9,      "year": 2026    },    "reversedAt": "2026-09-03T10:00:00Z",    "reversedOn": {      "day": 3,      "month": 9,      "year": 2026    },    "updatedAt": "2026-09-02T10:00:00Z"  },  "replayed": false}