bimetricsEntwickler
Zuordnungen

Erstattungsfähiges Guthaben einer Rechnungskorrektur lesen

Als Markdown ansehen

Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)

GET
/api/match/correction-settlement/{correctionDocumentId}

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.

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

Pfadparameter

correctionDocumentId*string

ID des ausgestellten Korrekturbelegs, nicht des Entwurfs (UUID).

Query-Parameter

targetDocumentId?string

Optionale ID einer Zielrechnung, um deren Kapazität und Revision mitzuprüfen.

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/correction-settlement/string" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
{  "correctionDocumentId": "895394db-2b8b-4b25-a36f-c4b7c14c6653",  "invoiceNumber": "RK-2026-0012",  "payments": [],  "refundAvailableMinor": 23800,  "revision": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f",  "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",  "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",  "sourceInvoiceNumber": "RE-2026-0142"}