# Erstattungsfähiges Guthaben einer Rechnungskorrektur lesen (https://developer.bimetrics.de/reference/matches/get-correction-settlement)

`GET https://app.bimetrics.de/api/match/correction-settlement/{correctionDocumentId}`

operationId: `getCorrectionSettlement` · Berechtigung (Scope): `sales:read` · Bereich: Zuordnungen

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

`Authorization: Bearer bm_…` (alternativ `X-API-KEY: bm_…`, nie beide zugleich).

### Parameter

| Name | Ort | Pflicht | Typ | Beschreibung |
| --- | --- | --- | --- | --- |
| `correctionDocumentId` | path | ja | string | ID des ausgestellten Korrekturbelegs, nicht des Entwurfs (UUID). |
| `targetDocumentId` | query | nein | string | Optionale ID einer Zielrechnung, um deren Kapazität und Revision mitzuprüfen. |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/match/correction-settlement/{correctionDocumentId}" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: CorrectionSettlementView |
| 400 | Ungültige Anfrage, z. B. ein Parameter mit ungültigem Wert wie eine ID, die keine UUID ist; korrigieren statt wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |
| 401 | Kein gültiger Schlüssel: fehlt (`Unauthorized`), ist unbekannt, abgelaufen oder widerrufen oder wurde nicht in genau einem Header gesendet (`InvalidAPIKey`). Schlüssel prüfen, nicht wiederholen. Auch eine ID, die zu einer anderen Firma gehört, ergibt `401 Unauthorized`. | `application/json`: Error |
| 403 | Dem Schlüssel fehlt die Berechtigung für diese Route (`APIKeyPermissionDenied`), oder die Firma hat keinen aktiven Tarif mit API-Zugang, etwa in der Testphase oder nach Ende des Abos (`APIUnavailable`). | `application/json`: Error |
| 404 | Nicht gefunden (`NotFound`). | `application/json`: Error |
| 413 | Die Anfrage ist zu groß (`APIRequestTooLarge`), siehe `x-bimetrics-limits`. | `application/json`: Error |
| 429 | Zu viele Anfragen; nach `Retry-After` Sekunden erneut senden. Mehr unter [Fehler](https://developer.bimetrics.de/errors). (Header: Retry-After) | `application/json`: Error |
| 500 | Serverfehler; die Anfrage später wiederholen. Mehr unter [Fehler](https://developer.bimetrics.de/errors). | `application/json`: Error |

#### Felder der Antwort 200 (`CorrectionSettlementView`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `correctionDocumentId` | string (uuid) | ID des ausgestellten Korrekturbelegs. |
| `disabledReason` | string | Sperrgrund payment_unknown, no_credit, reversed, document_unavailable, finalized oder account_unavailable. Ein gesperrter Nullwert bestätigt keinen ausgeführten Ausgleich. |
| `invoiceNumber` | string | Nummer des Korrekturbelegs. |
| `payments` | Array<CorrectionSettlementPayment>, kann null sein | Bisher erfasste Rückzahlungen und Verrechnungen einschließlich zurückgenommener Einträge. |
| `refundAvailableMinor` | integer | Aktuell erstattungs- oder verrechenbares Guthaben in EUR-Cent; bei disabledReason nicht verfügbar. |
| `revision` | string | Versionsdigest aus Original, Korrekturen, Zuordnungen und erfassten Zahlungen. Unverändert als expectedRevision senden. |
| `sourceDocumentId` | string (uuid) | ID der ursprünglichen Rechnung. |
| `sourceDraftId` | string (uuid) | ID des ursprünglichen Rechnungsentwurfs. |
| `sourceInvoiceNumber` | string | Nummer der ursprünglichen Rechnung. |
| `target` | CorrectionSettlementTarget | Optional mitgeprüfte Zielrechnung für eine Verrechnung. |

Verschachtelte Schemas stehen vollständig in der OpenAPI-Beschreibung: https://app.bimetrics.de/api/openapi.json