bimetricsEntwickler
Kassenbuch

Kassendatei abrufen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/cash-import-files/{id}

Liefert, was bimetrics aus der Kassendatei gelesen hat: Kassensystem, Kennung der Kasse, Kontenrahmen, Zeitraum, die Konten mit Bezeichnung und Rolle (vorgeschlagen, solange status mapping ist) und je Kassentag seinen Tagesabschluss mit Umsatz, Baranteil und der Zahl der Zeilen, die bimetrics nicht übernehmen kann. Die Werte und Zeilen eines Tages liefern getCashImport und getCashImportPages. Abrufen dürfen es alle Rollen.

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 der Kassendatei (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Eine Kassendatei: was bimetrics aus ihr gelesen hat, die Rollen ihrer Konten und ihre Kassentage.

accounts?array<>|

Die Gegenkonten der Datei mit Bezeichnung und Rolle.

balanceBeforeMinor?integer

Bestand vor dem ersten Tag in Cent.

batchHash?string

Prüfsumme der gemeinsam übernehmbaren Tage. Fehlt, wenn kein Tag bereit ist.

cashAccount?integer

Kassenkonto der Datei; 0 bei DSFinV-K.

cashBookId?string

Kassenbuch der Art register.

Formatuuid
chart?string

Kontenrahmen der Datei: SKR03 oder SKR04; fehlt bei DSFinV-K.

Wert in"SKR03""SKR04"
confirmedAt?string

Zeitpunkt, zu dem der Inhaber die Rollen der Konten bestätigt hat.

Formatdate-time
confirmedBy?string

Name des Inhabers, der die Rollen bestätigt hat.

createdAt?string

Zeitpunkt des Hochladens.

Formatdate-time
days?array<>|

Die Kassentage der Datei; ein Tag ohne Buchungen steht nicht darin.

fileKey?string

Kennung der Kasse aus Kassensystem und Kostenstelle (KOST1), etwa „belbo · KOST1 30“; bei DSFinV-K die Seriennummer der Kasse. Berater- und Mandantennummer gehören der Steuerkanzlei und zählen nicht.

fileName?string

Name der Datei beim Hochladen.

format?string

datev: DATEV-Buchungsstapel; dsfinvk: DSFinV-K-Export.

Wert in"datev""dsfinvk"
id?string

ID der Kassendatei.

Formatuuid
known?integer

Zahl der Tage, die mit denselben Zeilen schon übernommen sind und deshalb keinen Entwurf bekommen.

origin?string

Weg des Hochladens: web, api oder mcp.

periodFrom?

Beginn des Zeitraums laut Kopf der Datei.

periodTo?

Ende des Zeitraums laut Kopf der Datei.

sameFile?

Dieselbe Datei wurde schon einmal hochgeladen und nicht verworfen.

sha256?string

SHA-256 der Datei; sie wird nie ersetzt.

sizeBytes?integer

Größe der Datei in Byte.

status?string

mapping (die Konten warten auf ihre Rollen, beim ersten DSFinV-K-Export die Kasse auf ihre Bestätigung), read (jeder Kassentag ist ein Tagesabschluss) oder discarded (verworfen).

Wert in"mapping""read""discarded"
uploadedBy?string

Name der Person, die die Datei hochgeladen hat.

vendor?string

Kassensystem laut Kopf der Datei, etwa belbo.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-import-files/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "accounts": [    {      "account": 1360,      "label": "EC-Karte",      "lines": 6,      "role": "transit"    },    {      "account": 1363,      "label": "Kauf auf Rechnung",      "lines": 1,      "role": "on_account"    },    {      "account": 1718,      "label": "Behandlungspakete",      "lines": 4,      "role": "prepaid"    },    {      "account": 4980,      "label": "Sonstiger Betriebsbedarf",      "lines": 3,      "role": "payout"    },    {      "account": 8400,      "label": "Umsatzerlöse 19 %",      "lines": 17,      "role": "revenue"    }  ],  "balanceBeforeMinor": 100000,  "batchHash": "abababababababababababababababababababababababababababababababab",  "cashAccount": 1000,  "cashBookId": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",  "chart": "SKR03",  "confirmedAt": "2026-04-02T09:24:00Z",  "confirmedBy": "Jana Kröger",  "createdAt": "2026-04-02T09:20:00Z",  "days": [    {      "cashChangeMinor": -55,      "cashMinor": 4185,      "day": {        "day": 3,        "month": 3,        "year": 2026      },      "importId": "6e2a4c8b-3d5f-4b79-9c1e-4a6b8d0f2c35",      "lines": 10,      "ready": true,      "revenueMinor": 34075,      "status": "read",      "unsupported": 0    },    {      "cashChangeMinor": 5980,      "cashMinor": 5980,      "day": {        "day": 4,        "month": 3,        "year": 2026      },      "importId": "7f3b5d9c-4e6a-4c8a-8d2f-5b7c9e1a3d46",      "lines": 11,      "ready": true,      "revenueMinor": 69495,      "status": "read",      "unsupported": 0    }  ],  "fileKey": "belbo · KOST1 30",  "fileName": "belbo-export-2026-03.csv",  "format": "datev",  "id": "5d1f3b7a-2c4e-4a68-8b0d-3f5a7c9e1b24",  "known": 0,  "origin": "web",  "periodFrom": {    "day": 1,    "month": 3,    "year": 2026  },  "periodTo": {    "day": 31,    "month": 3,    "year": 2026  },  "sha256": "3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a5c7e9b1d3f5a7c9e1b3d5f7a9c1e3b5d",  "sizeBytes": 18597,  "status": "read",  "uploadedBy": "Jana Kröger",  "vendor": "belbo"}

Monat eines Kassenbuchs als Seitenbilder GET

Liefert dasselbe PDF wie `GET /api/cash-books/{id}/pdf` als Base64 (`pdf`) und seine Seiten als PNG-Bilder (`pages`), höchstens die ersten 20. So lässt sich ein Monat lesen, bevor man ihn abschließt, ohne PDF-Anzeige. Bei einem abgeschlossenen Monat steht im PDF die Zählung, auf die sich der Abschluss stützt, als „Zählung zum Abschluss“. Ein Monat vor dem Beginn des Kassenbuchs oder nach dem laufenden Monat ergibt `400 CashBookRejected` mit Feld `month`. Abrufen dürfen es alle Rollen. Benötigt einen Schlüssel mit der Berechtigung `read`.

Konten einer Kassendatei zuordnen POST

Bestätigt die Rollen der Konten einer Kassendatei, die darauf wartet (`status: mapping`). Ein Konto in `accounts` bekommt seine Rolle, eine leere Rolle heißt keine; ein Konto, das fehlt, behält die angezeigte. Die Zuordnung gilt danach für die Kasse und steht mit jeder Änderung im Protokoll. Die erste Bestätigung setzt außerdem die Kennung der Kasse (`registerFileKey`), danach nimmt die Kasse nur Dateien mit dieser Kennung. Anschließend wird jeder Kassentag der Datei ein Entwurf eines Tagesabschlusses; ein Tag mit einem Konto ohne Rolle hält in der Prüfung an. Ein DSFinV-K-Export hat keine Konten: Bei seinem ersten Export bestätigt der Inhaber ohne `accounts`, dass die Kasse mit der Seriennummer `fileKey` diese Kasse ist. Jede Rolle muss zum Konto passen wie bei `changeRegisterFileAccounts`, sonst `400 CashBookRejected` mit dem Konto im Satz. Ändert oder entfernt die Bestätigung eine Rolle, die die Kasse schon kennt, übernehmen die übrigen Kassendateien sie, und ihre offenen Entwürfe werden neu gelesen. Gebucht wird nichts. Nur Inhaber (`403 CashBookOwnerOnly`). Bei einer Wiederholung schickst du denselben Idempotency-Key. Benötigt einen Schlüssel mit der Berechtigung `company:write`.