bimetricsEntwickler
Kassenbuch

Monat abschließen

Als Markdown ansehen

Benötigte Berechtigung:matching:write(Belege und Zahlungen zuordnen)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/cash-books/{id}/months/{month}/close

Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.

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.

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.

Header-Parameter

Idempotency-Key*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.

Muster^[!-~]+$
Länge1 <= length <= 128

Request-Body

expectedClosingMinor from the preview

application/json
  1. body

Monat abschließen.

expectedClosingMinor?integer

Pflicht: closingMinor der Prüfung, in Cent. Weicht der Endbestand ab, antwortet die Route mit 409 CashBookRejected und schließt nichts ab.

expectedEntries?integer

Pflicht: entries der Prüfung. Weicht die Zahl der Einträge ab, etwa nach einem Storno, antwortet die Route mit 409 CashBookRejected und schließt nichts ab.

Antworten

Erfolg.

application/json
  1. response

Abgeschlossener Monat.

finalized?integer

Zahl der Buchungen, die der Abschluss festgeschrieben hat.

period?

Der Abschluss.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-books/497f6eca-6276-4993-bfeb-53cbbbba6f08/months/string/close" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "finalized": 14,  "period": {    "cashBookId": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",    "closedAt": "2026-11-03T08:15:00Z",    "closingMinor": 14850,    "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",    "countId": "5b8e1f3a-2c4d-4e6f-9a1b-7d3c5e9f2a48",    "createdAt": "2026-11-03T08:15:00Z",    "id": "9a4c2e6b-1d3f-4b58-8c7e-3f5a1b9d2e64",    "month": 10,    "openingMinor": 20000,    "origin": "api",    "updatedAt": "2026-11-03T08:15:00Z",    "year": 2026  }}

Kassenbuch-Einträge prüfen POST

Prüft Einträge wie `POST /api/cash-books/{id}/entries` und sagt, was sie buchen würden (`bookings`) und wie viel Geld danach in der Kasse ist, ohne etwas zu schreiben. Die Nummern heißen in der Vorschau `neu`. Benötigt einen Schlüssel mit der Berechtigung `read`.

Monatsabschluss prüfen POST

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`.