# Privat bezahlt: Stand der Firma lesen (https://developer.bimetrics.de/reference/matches/get-private-payment-state)

`GET https://app.bimetrics.de/api/match/payment/private`

operationId: `getPrivatePaymentState` · Berechtigung (Scope): `read` · Bereich: Zuordnungen

Sagt, wie bimetrics eine private Zahlung (`recordPayment` mit `method` `private`) für diese Firma bucht, und bei GmbH und UG, was die Firma dem Gesellschafter noch schuldet. Den Zahlungsstand eines einzelnen Belegs liefert `getDocument` (`remainingPaymentMinor`, `recordedPayments`). Nur mit eingeschalteter Zahlungserfassung (`manualPaymentsEnabled`), sonst `403 ManualPaymentUnavailable`.

Benötigt einen Schlüssel mit der Berechtigung `read`.

### Authentifizierung

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

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/match/payment/private" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: PrivatePaymentState |
| 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 API-Zugang (mehr), etwa nach Ende der Testphase oder des Abos (`APIUnavailable`). | `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 (`PrivatePaymentState`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `account` | integer | Konto, auf das bimetrics private Zahlungen bucht, bei GmbH und UG 1665 (SKR03) bzw. 3640 (SKR04); fehlt, wenn keine private Zahlung möglich ist. |
| `openMinor` | integer | Nur bei `shareholder`: was die Firma auf diesem Konto seit dem Start in bimetrics noch schuldet, über alle Belege, in Cent; negativ, wenn sie mehr zurückgezahlt hat. Zurückgezahlt wird mit der Buchungsvorlage „Gesellschafter-Verrechnung“. |
| `paidBy` | string | `paidBy` der aktiven privaten Zahlungen, wenn alle denselben Namen tragen; fehlt sonst. |
| `treatment` | string: `shareholder`, `owner`, `legal_form_missing`, `unsupported` | Buchung nach Rechtsform: `shareholder` (GmbH, UG) als Schuld an den Gesellschafter, `owner` (Einzelunternehmen, GbR, OHG) als Privateinlage, `legal_form_missing` erst, wenn die Rechtsform in der App eingetragen ist, `unsupported` für andere Rechtsformen nicht möglich. |

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