bimetricsEntwickler
Zuordnungen

Erfasste Rückzahlung oder Verrechnung 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/correction-settlement/reverse

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

Nimmt eine aktive Erfassung durch Gegenbuchungen zurück. paymentId bezeichnet die negative Zahlung am Korrekturbeleg. Bei einer Verrechnung werden beide Seiten atomar zurückgenommen; dann sind expectedRevision und expectedTargetRevision erforderlich. Die ursprünglichen Buchungen bleiben auch bei Festschreibung unverändert erhalten. Unklare Zahlungsstände sperren die Rücknahme. Kein Löschen, keine neue Auszahlung und kein Zahlungsauftrag.

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

Current revisions and payment UUID

TypeScript-Typen

Typ request body für TypeScript.

Rücknahme der Erfassung durch Gegenbuchungen, bei Verrechnung immer für das vollständige Paar.

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/correction-settlement/reverse" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "paymentId": "d5e264b8-4c4a-4155-a71a-c0bd9d9c757f",  "replayed": false,  "settlement": {    "correctionDocumentId": "895394db-2b8b-4b25-a36f-c4b7c14c6653",    "invoiceNumber": "RK-2026-0012",    "payments": [      {        "payment": {          "account": 1360,          "accountContra": 11004,          "amountMinor": -10000,          "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",          "createdAt": "2026-10-08T10:00:00Z",          "currency": "EUR",          "documentId": "895394db-2b8b-4b25-a36f-c4b7c14c6653",          "id": "d5e264b8-4c4a-4155-a71a-c0bd9d9c757f",          "method": "clearing",          "origin": "api",          "paidOn": {            "day": 8,            "month": 10,            "year": 2026          },          "reversedAt": "2026-10-09T10:00:00Z",          "reversedOn": {            "day": 9,            "month": 10,            "year": 2026          },          "settlementPairId": "0a77fbdb-3378-4650-88cc-aa9db8b0f85e",          "updatedAt": "2026-10-08T10:00:00Z"        },        "targetDocumentId": "94c38d05-f204-493e-bcd8-d7f1e75cd1c6",        "targetInvoiceNumber": "RE-2026-0145"      }    ],    "refundAvailableMinor": 23800,    "revision": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f",    "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",    "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",    "sourceInvoiceNumber": "RE-2026-0142",    "target": {      "customerName": "Brauhaus Elbwiese GmbH",      "documentId": "94c38d05-f204-493e-bcd8-d7f1e75cd1c6",      "invoiceNumber": "RE-2026-0145",      "openMinor": 35700,      "revision": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f"    }  }}

Bereits erfolgte Rückzahlung erfassen POST

Dokumentiert eine bereits ausgeführte Bar- oder Verrechnungszahlung zum ausgestellten Korrekturbeleg. amountMinor ist positiv in EUR-Cent und höchstens refundAvailableMinor; der Server erfasst die Auszahlung mit negativem Vorzeichen. expectedRevision muss dem zuletzt gelesenen Guthabenstand entsprechen. Bereits über importierte Bankumsätze zugeordnete Rückzahlungen dürfen nicht erneut erfasst werden. Erzeugt eine Zahlungsbuchung, aber keinen Bankumsatz und keinen Zahlungsauftrag. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

Erstattungsfähiges Guthaben einer Rechnungskorrektur lesen GET

Liefert die aktuelle Kapazität und bisher erfasste Rückzahlungen oder Verrechnungen einer ausgestellten Rechnungskorrektur. Die Kapazität ist sowohl durch deren eigenen Restbetrag als auch durch das Guthaben der Originalrechnung einschließlich aller Korrekturen und Zahlungen begrenzt. Unklarer Zahlungsstand sperrt neue Erfassungen. Eine Minderung einer unbezahlten Rechnung ist noch kein auszahlbares Guthaben. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.