bimetricsEntwickler
Kassenbuch

Monatsabschluss prüfen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

POST
/api/cash-books/{id}/months/{month}/close/preview

Prüft, ob sich ein Monat des Kassenbuchs abschließen lässt, ohne etwas zu schreiben. items nennt jede Prüfung mit ok: ended (der Monat ist vorbei, in deutscher Zeit), previous (alle früheren Monate seit dem Beginn sind abgeschlossen), counted (seit dem Monatsersten wurde gezählt, auch nach Monatsende; ohne Zählung erfüllt die Stilllegung des Kassenbuchs ab dem Monatsersten den Punkt, dann steht ihr Zeitpunkt in archivedAt), countAgrees (eine maßgebliche Zählung trägt den Monat: Die Prüfung beginnt bei der letzten Zählung im Monat, ohne sie bei der ersten danach, und geht zur nächsten Zählung weiter, solange eine veraltet ist oder eine Differenz offen ließ; veraltet ist eine Zählung, wenn nach ihr ein Eintrag mit einem Kassentag bis zu ihrem Tag erfasst wurde, auch ein Storno, lateEntryDate nennt seinen Kassentag. Die erste gültige Zählung, die stimmte oder ihre Differenz gebucht hat, ist maßgeblich und steht in count; eine offene Differenz einer späteren Zählung hält den Monat dann nicht auf. Wurde das Kassenbuch nach der letzten Zählung dieser Kette stillgelegt, erfüllt die Stilllegung den Punkt bis zu ihrem Monat, mit archivedAt), neverNegative (der Bestand lag nach keiner Buchung des Monats unter 0 €) und gapless (die Nummern des Jahres sind bis zur letzten Buchung des Monats lückenlos). Dazu kommen Anfangs- und Endbestand, die Zahl der Einträge und der Buchungen, die der Abschluss festschreibt, und mit bankMissing die Einträge Bank ↔ Kasse ohne Bankumsatz, die den Abschluss nicht aufhalten. ready heißt: alles erfüllt und noch nicht abgeschlossen. canClose sagt, ob der Aufrufer abschließen darf (Inhaber und Steuerberatung). Ist der Monat schon abgeschlossen, steht der Abschluss in closed. Ist das Kassenbuch ausgeschaltet, steht disabled auf true und kein Monat lässt sich abschließen, bis es wieder eingeschaltet ist. Ein Monat vor dem Beginn des Kassenbuchs oder nach dem laufenden Monat ergibt 400 CashBookRejected mit Feld month. Lesen dürfen 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 des Kassenbuchs (UUID).

Formatuuid
month*string

Monat als JJJJ-MM, etwa 2026-10.

Antworten

Erfolg.

application/json
  1. response

Prüfung eines Monatsabschlusses.

bankMissing?integer

Zahl der Einträge Bank ↔ Kasse des Monats, denen der Bankumsatz noch fehlt. Sie halten den Abschluss nicht auf, zuordnen lässt er sich auch danach. Fehlt bei 0 und bei einem abgeschlossenen Monat.

canClose?boolean

true für Inhaber und Steuerberatung: Sie dürfen abschließen.

closed?

Der Abschluss, wenn der Monat schon abgeschlossen ist; die Prüfungen zeigen dann den Stand beim Abschluss.

closingMinor?integer

Bestand nach dem Monat, in Cent; als expectedClosingMinor beim Abschließen mitschicken.

disabled?boolean

true, wenn das Kassenbuch ausgeschaltet ist: Dann lässt sich kein Monat abschließen, ready ist false. Fehlt sonst.

entries?integer

Zahl der Einträge des Monats, Stornos eingeschlossen; als expectedEntries beim Abschließen mitschicken.

finalize?integer

Zahl der noch offenen Buchungen, die der Abschluss festschreibt.

items?array<>|

Die Prüfungen in fester Reihenfolge.

month?string

Der Monat als JJJJ-MM.

openingMinor?integer

Bestand vor dem Monat, in Cent.

ready?boolean

true, wenn alle Prüfungen erfüllt sind und der Monat noch offen ist.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-books/497f6eca-6276-4993-bfeb-53cbbbba6f08/months/string/close/preview" -X POST \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "bankMissing": 1,  "canClose": true,  "closingMinor": 14850,  "entries": 12,  "finalize": 14,  "items": [    {      "key": "ended",      "ok": true    },    {      "key": "previous",      "ok": true    },    {      "count": {        "cashBookId": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",        "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",        "createdAt": "2026-10-31T17:30:00Z",        "day": {          "day": 31,          "month": 10,          "year": 2026        },        "denominations": {          "50": 3,          "200": 1,          "500": 1,          "2000": 2,          "5000": 2        },        "differenceMinor": 0,        "expectedMinor": 14850,        "id": "5b8e1f3a-2c4d-4e6f-9a1b-7d3c5e9f2a48",        "origin": "api",        "resolution": "match",        "totalMinor": 14850,        "updatedAt": "2026-10-31T17:30:00Z"      },      "key": "counted",      "ok": true    },    {      "count": {        "cashBookId": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",        "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",        "createdAt": "2026-10-31T17:30:00Z",        "day": {          "day": 31,          "month": 10,          "year": 2026        },        "denominations": {          "50": 3,          "200": 1,          "500": 1,          "2000": 2,          "5000": 2        },        "differenceMinor": 0,        "expectedMinor": 14850,        "id": "5b8e1f3a-2c4d-4e6f-9a1b-7d3c5e9f2a48",        "origin": "api",        "resolution": "match",        "totalMinor": 14850,        "updatedAt": "2026-10-31T17:30:00Z"      },      "key": "countAgrees",      "ok": true    },    {      "key": "neverNegative",      "ok": true    },    {      "key": "gapless",      "ok": true    }  ],  "month": "2026-10",  "openingMinor": 20000,  "ready": true}

Monat abschließen POST

Schließt einen Monat des Kassenbuchs endgültig ab, wenn alle Prüfungen von `POST /api/cash-books/{id}/months/{month}/close/preview` erfüllt sind; sonst `409 CashBookRejected`. Monate schließen streng nacheinander, nie der laufende. Der Abschluss merkt sich die maßgebliche Zählung (`countId`). `expectedClosingMinor` und `expectedEntries` sind Pflicht: Endbestand und Zahl der Einträge aus der Prüfung. Hat sich der Monat seitdem geändert, antwortet die Route mit `409 CashBookRejected` und schließt nichts ab. Auch ein stillgelegtes Kassenbuch schließt seine Monate ab, denn der Abschluss bewegt kein Geld. Danach geht keine Buchung und keine Barzahlung am Beleg mehr in diesen Monat (`400 CashBookRejected`, Feld `entryDate`). Ein Storno einer Buchung aus dem Monat kommt mit heutigem Datum und einer Nummer seines Jahres in den laufenden Monat und verweist auf das Original. Alle noch offenen Buchungen der Einträge des Monats werden festgeschrieben (`finalizedBy` `cashbook`), auch die der Barzahlungen an Belegen. Zurücknehmen lässt sich der Abschluss nicht. Abschließen dürfen Inhaber und Steuerberatung, nicht der Nutzer (`403 CashBookOwnerOnly`). Bei einer Wiederholung schickst du denselben Idempotency-Key und bekommst den geschriebenen Abschluss. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

Monat eines Kassenbuchs als PDF GET

Liefert einen Monat des Kassenbuchs als PDF, zum Ausdrucken oder Weitergeben, etwa an die Steuerberatung. Das PDF enthält Firma, Kasse, Kassenkonto und Monat, den Bestand am Monatsanfang und am Monatsende, Einnahmen und Ausgaben sowie jede Buchung mit Datum, Nummer, Text, Betrag und dem Bestand danach. Ein Storno steht mit eigener Nummer im PDF und verweist auf die stornierte Buchung; diese bleibt durchgestrichen sichtbar. Darunter stehen die Zählungen des Monats mit Zeitpunkt, Person, Stückelung und Ergebnis; bei einem abgeschlossenen Monat nennt das PDF Tag und Person des Abschlusses und vorweg die Zählung, auf die er sich stützt („Zählung zum Abschluss“), nach Monatsende mit Endbestand und den Buchungen bis zur Zählung. Das PDF wird bei jedem Aufruf neu aus den Einträgen erzeugt; sind Buchungen des Monats schon an DATEV übergeben, steht das im PDF. 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`.