bimetricsEntwickler
Zuordnungen

Bereits erfolgte Rückzahlung erfassen

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/refund

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

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.

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

Gelesene Revision der Korrektur und ein positiver Betrag in EUR-Cent

application/json
  1. body

Eine bereits erfolgte Rückzahlung dokumentieren, ohne Bankauftrag.

amountMinor?integer

Positiver ausgezahlter Betrag in EUR-Cent, höchstens refundAvailableMinor. Kein negatives Vorzeichen senden.

Bereich1 <= value
correctionDocumentId?string

ID des ausgestellten Korrekturbelegs.

Formatuuid
expectedRevision?string

Erforderlicher unveränderter revision-Wert aus getCorrectionSettlement.

method?string

cash für Barzahlung oder clearing für einen außerhalb importierter Bankumsätze erfolgten Ausgleich. Das Buchungskonto bestimmt der Server.

Wert in"cash""clearing"
paidOn?

Tatsächliches Datum der bereits ausgeführten Rückzahlung, höchstens heute und nicht vor dem Datum des Korrekturbelegs.

Antworten

Erfolg.

application/json
  1. response

Erfassung oder Rücknahme mit anschließend neu gelesenem Guthabenstand.

paymentId?string

ID der negativen Zahlung am Korrekturbeleg; bei Rücknahme bleibt diese ID erhalten.

Formatuuid
replayed?boolean

True bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs mit demselben Idempotency-Key.

settlement?|

Aktueller Guthabenstand und vollständiger Erfassungsverlauf nach dem Aufruf.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/match/correction-settlement/refund" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "paymentId": "d5e264b8-4c4a-4155-a71a-c0bd9d9c757f",  "replayed": false,  "settlement": {    "bankPayments": [],    "correctionDocumentId": "895394db-2b8b-4b25-a36f-c4b7c14c6653",    "invoiceNumber": "RK-2026-0012",    "payments": [      {        "payment": {          "account": 1000,          "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": "cash",          "origin": "api",          "paidOn": {            "day": 8,            "month": 10,            "year": 2026          },          "updatedAt": "2026-10-08T10:00:00Z"        }      }    ],    "refundAvailableMinor": 13800,    "revision": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f",    "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",    "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",    "sourceInvoiceNumber": "RE-2026-0142"  }}