# Z-Bon hochladen (https://developer.bimetrics.de/reference/cash-book/upload-cash-import)

`POST https://app.bimetrics.de/api/cash-books/{id}/imports`

operationId: `uploadCashImport` · Berechtigung (Scope): `matching:write` · Bereich: Kassenbuch

Speichert den Z-Bon eines Kassensystems unverändert und mit seiner SHA-256-Prüfsumme in einer Kasse der Art `register`. Im Hintergrund liest bimetrics ihn dann: erst den Text, dann die Werte, jeden mit der Textstelle, aus der er stammt. Die Antwort kommt mit `status: reading`; `getCashImport` liefert die Werte, sobald `status` `read` ist, meist nach 10 bis 30 Sekunden. Gebucht wird noch nichts. Hochladen dürfen Inhaber und Nutzer, nicht die Steuerberatung. Bei einer Wiederholung schickst du denselben Idempotency-Key.

Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

> **Achtung:** Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
>
> KI-Agenten fragen vor diesem Aufruf beim Nutzer nach.

### Authentifizierung

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

### Parameter

| Name | Ort | Pflicht | Typ | Beschreibung |
| --- | --- | --- | --- | --- |
| `id` | path | ja | string (uuid) | ID des Kassenbuchs (UUID). |
| `Idempotency-Key` | header | ja | 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. |

### Request-Body (`multipart/form-data`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `file` (Pflicht) | string (binary) | Der Z-Bon als Foto (JPEG oder PNG) oder als PDF, höchstens 30 MB. |

### Beispiel

```sh
curl --fail-with-body "https://app.bimetrics.de/api/cash-books/{id}/imports" \
  -H "Authorization: Bearer $BIMETRICS_API_KEY" \
  -H "Idempotency-Key: rechnung-2026-001" \
  -F "auto[]=@rechnung.pdf"
```

### Antworten

| Status | Beschreibung | Inhalt |
| --- | --- | --- |
| 200 | Erfolg. | `application/json`: CashImport |
| 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 diesen Endpunkt (`APIKeyPermissionDenied`, `context.scope` nennt sie; Berechtigungen sind fest: neuen Schlüssel anlegen, austauschen, alten widerrufen), der Endpunkt ist für API-Schlüssel nicht freigegeben (`APIKeyPermissionDenied` ohne `context.scope`), oder die Firma hat keinen API-Zugang (mehr), etwa nach Ende der Testphase oder des Abos (`APIUnavailable`). | `application/json`: Error |
| 404 | Nicht gefunden (`NotFound`). | `application/json`: Error |
| 409 | Versionskonflikt (`VersionConflict`), abweichender Inhalt für denselben Idempotency-Key (`IdempotencyConflict`), Dublette (`ContactDuplicate`) oder fachlich gesperrte Änderung. Aktuellen Zustand laden und prüfen; keinen anderen Schlüssel verwenden, um einen Konflikt zu umgehen. | `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 (`CashImport`)

| Feld | Typ | Beschreibung |
| --- | --- | --- |
| `cashBookId` | string (uuid) | Kassenbuch der Art `register`. |
| `createdAt` | string (date-time) | Zeitpunkt des Hochladens. |
| `day` | NaiveDate | Tag des Tagesabschlusses laut Z-Bon. |
| `duplicateOf` | CashImportTaken | Bei einem Entwurf: der übernommene Tagesabschluss, den er wiederholt, nach derselben Regel wie die Prüfung `duplicate` von `previewCashImport`, bevor die Rückfrage zum Neustart beantwortet ist. Gleich sind dieselbe Z-Nummer am selben Tag, dieselbe Datei, dieselbe Z-Nummer mit derselben Kassen-ID und denselben Summen an einem anderen Tag oder dieselbe Z-Nummer in seiner Z-Folge. Übernehmen lässt sich der Entwurf nicht. Nur in `listCashImports`. |
| `fileImportId` | string (uuid) | Die Kassendatei, aus der der Tag stammt. |
| `fileName` | string | Name der Datei beim Hochladen. |
| `fileType` | string | `pdf` für ein PDF, `photo` für ein Foto (JPEG oder PNG), erkannt am Inhalt der Datei; `datev` oder `dsfinvk` für einen Tag aus einer Kassendatei. |
| `group` | string | Bei einem Entwurf: gleich für Entwürfe, die in allen buchungsrelevanten Werten übereinstimmen (Kassen-ID, Z-Nummer, Tag, Umsatz je Steuersatz, Zahlarten, Gutscheine, Trinkgeld, Bewegungen, Sonderzeilen, Kassendifferenz und Endbestand), etwa zwei Fotos eines Z-Bons. Entwürfe derselben Z-Nummer in anderen Gruppen weichen in einem Wert ab. Nur in `listCashImports`. |
| `id` | string (uuid) | ID des Tagesabschlusses. |
| `origin` | string | Weg des Hochladens: `web`, `api` oder `mcp`. |
| `readFailure` | string | Bei `failed` der Grund: kein Text erkannt oder die Erkennung hat den Z-Bon abgelehnt (`unreadable`), keine Z-Nummer (`no_z_number`), kein Z-Bon (`not_a_z_bon`) oder die Erkennung war nach drei Versuchen nicht erreichbar (`unavailable`). |
| `registerId` | string | Kassen-ID laut Z-Bon. |
| `sameDay` | CashImportTaken | Bei einem Entwurf: ein übernommener Tagesabschluss seines Tages mit anderer Z-Nummer, der mit der nächstliegenden Nummer. Es ist ein zweiter Abschluss des Tages oder eine Korrektur; `previewCashImport` prüft das mit `correction` bzw. `shift`. Nur in `listCashImports`. |
| `sameFile` | CashImportSameFile | Dieselbe Datei wurde schon einmal hochgeladen; fehlt, wenn das Lesen des früheren Uploads gescheitert ist. |
| `sha256` | string | SHA-256 der Datei; sie wird nie ersetzt. |
| `sizeBytes` | integer | Größe der Datei in Byte. |
| `source` | string: `zbon`, `datev`, `dsfinvk` | `zbon` für einen Z-Bon, `datev` für einen Tag aus einem DATEV-Buchungsstapel, `dsfinvk` für einen Kassenabschluss aus einem DSFinV-K-Export. |
| `status` | string | `reading` (wird gelesen), `read` (gelesen, Werte warten auf die Bestätigung), `failed` (nicht lesbar), `applied` (übernommen), `reversed` (als Ganzes storniert) oder `discarded` (Entwurf verworfen). |
| `summary` | CashImportSummary | Summen der übernommenen, sonst der gelesenen Werte; fehlt, solange es keine gibt (`reading`, `failed`). Nur in `listCashImports`. |
| `textSource` | string | `pdf`: Werte aus der Textschicht eines PDFs; `vision`: bimetrics hat den Text erst aus dem Bild gelesen. |
| `truncated` | boolean | `true`, wenn der Z-Bon mehr Text hat, als bimetrics liest; sein Ende wurde nicht gelesen. |
| `unsure` | integer | Zahl der Werte und Arten von Bewegungen, die der Nutzer noch bestätigen muss. |
| `uploadedBy` | string | Name der Person, die den Z-Bon hochgeladen hat. |
| `values` | ZBonValues | Die gelesenen Werte, sobald `status` `read` ist. |
| `zNumber` | integer | Z-Nummer laut Z-Bon. |
| `zSeries` | integer | Z-Folge eines übernommenen Tagesabschlusses, ab 1; ein bestätigter Neustart der Z-Nummern beginnt die nächste. |

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