bimetricsEntwickler
Kassenbuch

Tagesabschluss abrufen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/cash-imports/{id}

Liefert den Stand des Tagesabschlusses und, sobald der Z-Bon gelesen ist, seine Werte: Z-Nummer, Tag, Umsatz je Steuersatz, Zahlarten, Trinkgeld, Gutscheine, Bargeldbewegungen, Differenz und Kassenbestand. Zu jedem Wert gehören die Textstelle (quote) und die Angabe, ob er sicher ist (sure). Sicher ist ein Betrag nur, wenn er rechnerisch zu einer Summe auf dem Z-Bon passt. Z-Nummer, Tag und Kassen-ID sind nur sicher, wenn sie aus der Textschicht eines PDFs stammen; die Kennzeichnung als Korrektur (correction) kann es auch bei einem Foto sein. Die Art einer Bewegung ist nur sicher, wenn der Z-Bon sie eindeutig nennt. unsure zählt die Werte und Arten, die der Nutzer noch bestätigen muss. readFailure nennt bei status: failed den Grund: unreadable, no_z_number, not_a_z_bon oder unavailable.

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

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Pfadparameter

id*string

ID des Tagesabschlusses (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Tagesabschluss eines Kassensystems: der Z-Bon und, sobald gelesen, seine Werte.

cashBookId?string

Kassenbuch der Art register.

Formatuuid
createdAt?string

Zeitpunkt des Hochladens.

Formatdate-time
day?

Tag des Tagesabschlusses laut Z-Bon.

duplicateOf?

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

Die Kassendatei, aus der der Tag stammt.

Formatuuid
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

ID des Tagesabschlusses.

Formatuuid
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?

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?

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 für einen Z-Bon, datev für einen Tag aus einem DATEV-Buchungsstapel, dsfinvk für einen Kassenabschluss aus einem DSFinV-K-Export.

Wert in"zbon""datev""dsfinvk"
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?

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?

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.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-imports/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "cashBookId": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",  "createdAt": "2026-11-12T19:10:00Z",  "day": {    "day": 12,    "month": 11,    "year": 2026  },  "fileName": "z-bon-1187.jpg",  "fileType": "photo",  "id": "4a8c2e6f-1b3d-4f57-9a0c-2e4f6a8b0c13",  "origin": "web",  "registerId": "1",  "sha256": "9f2c4e6a8b0d1f3a5c7e9b1d3f5a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1a",  "sizeBytes": 812345,  "source": "zbon",  "status": "read",  "textSource": "pdf",  "unsure": 2,  "uploadedBy": "Jana Kröger",  "values": {    "day": {      "quote": "12.11.2026 19:04",      "sure": true,      "value": "2026-11-12"    },    "movements": [      {        "amount": {          "minor": 950,          "quote": "Entnahme 9,50",          "sure": false        },        "in": false,        "kind": "payout",        "kindSure": false,        "label": "Entnahme",        "text": "Post"      }    ],    "payments": {      "card": [        {          "amount": {            "minor": 80250,            "quote": "EC 802,50",            "sure": true          },          "label": "EC"        }      ],      "cash": {        "minor": 51800,        "quote": "Bar 518,00",        "sure": true      },      "voucher": {        "minor": 6000,        "quote": "Gutschein 60,00",        "sure": true      }    },    "registerId": {      "quote": "Kasse 1",      "sure": true,      "value": "1"    },    "revenue": [      {        "gross": {          "minor": 138050,          "quote": "MwSt 19% 1.380,50",          "sure": true        },        "rate": 19      }    ],    "tips": {},    "zNumber": {      "quote": "Z-Nr. 1187",      "sure": true,      "value": "1187"    }  },  "zNumber": 1187}

Kassendatei verwerfen POST

Verwirft die Datei und ihre offenen Tagesentwürfe. Das Original und das Protokoll bleiben erhalten. Sobald ein Kassentag aus der Datei gebucht wurde, ist das Verwerfen gesperrt. Inhaber und Nutzer dürfen verwerfen. Verwende bei einer Wiederholung denselben Idempotency-Key. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

Tagesabschluss übernehmen POST

Bucht den Tagesabschluss so, wie `previewCashImport` ihn gezeigt hat, in einem Schritt. Ins Kassenbuch kommt nur Bargeld: der Baranteil des Umsatzes, bares Trinkgeld fürs Team und seine Auszahlung, Auszahlungen, Lohn, Geld von und zur Bank, Privatentnahmen und -einlagen, die Kassendifferenz. Kartenzahlungen buchen auf Geldtransit (SKR03 1360, SKR04 1460), als Zahlart eingelöste Mehrzweck-Gutscheine auf „Ausgegebene Geschenkgutscheine“ (1796, 3786), Trinkgeld fürs Team auf durchlaufende Posten (1590, 1370), Lohn auf „Verbindlichkeiten aus Lohn und Gehalt“ (1740, 3720). Jede Zeile bucht am Kassentag, ohne Debitor oder Kreditor und mit eigenem Buchungstext. Eine Auszahlung wartet ohne Buchung auf ihren Beleg. Die Route lehnt ab, solange eine Prüfung anhält oder fragt, wenn sich Werte oder Bestand seit der Prüfung geändert haben (`valuesHash`, `expectedBalanceMinor`), und für die Steuerberatung (`403 CashBookOwnerOnly`). Danach lässt sich der Tagesabschluss nur noch als Ganzes stornieren. Bei einer Wiederholung schickst du denselben Idempotency-Key. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.