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- oder Verrechnungszahlung durch Gegenbuchung zurück. 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

AuthentifizierungBearer <token>

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

In: header

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

Payment reversal

TypeScript-Typen

Typ request body für TypeScript.

Rücknahme einer erfassten Zahlung durch Gegenbuchung.

Antworten

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/payment/reverse" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "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}

Bereits erfolgte Zahlung erfassen POST

Dokumentiert eine bereits erfolgte Bar- oder Verrechnungszahlung zu einem Beleg. Standardmäßig ausgeschaltet (manualPaymentsEnabled); erwartet expectedAmountOpenMinor zusätzlich zur Belegversion. Betrag in Cent, Währung EUR. Das Gegenkonto bestimmt der Server. Erzeugt weder eine Banktransaktion noch einen Zahlungsauftrag. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

Offenen Zuordnungsbetrag berechnen POST

Berechnet den offenen Betrag für ausgewählte Belege und Umsätze ohne Speicherung. Betrag als Dezimalzahl in Euro. Benötigt einen Schlüssel mit der Berechtigung `read`.