bimetricsEntwickler
Kassenbuch

Kassenbuch stilllegen

Als Markdown ansehen

Benötigte Berechtigung:company:write(Firmendaten ändern)

Echte Wirkung

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

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

Legt ein Kassenbuch still. Das geht nur, wenn kein Geld mehr darin ist (balanceMinor 0), sonst 409 CashBookRejected. Es bleibt lesbar, sein Kassenkonto wird frei für ein neues Kassenbuch. Zurückholen lässt es sich nicht. Ist es schon stillgelegt, ändert sich nichts.

Benötigt einen Schlüssel mit der Berechtigung company: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

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

Antworten

Erfolg.

application/json
  1. response

Kassenbuch der Firma.

account?integer

Kassenkonto im Kontenrahmen der Firma: 1000, 1010 oder 1020 in SKR03, 1600, 1610 oder 1620 in SKR04.

archivedAt?string

Stillgelegt seit diesem Zeitpunkt. Fehlt, solange das Kassenbuch in Gebrauch ist.

Formatdate-time
balanceMinor?integer

Geld, das jetzt in der Kasse sein muss, in Cent.

companyId?string

ID der Firma.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
id?string

ID des Kassenbuchs.

Formatuuid
kind?string

petty für eine Handkasse. shop (offene Ladenkasse) und register (Kassensystem mit TSE) lehnt das Anlegen vorerst mit 400 und Feld kind ab, bis bimetrics ihre Tageseinnahmen kann.

Wert in"petty""shop""register"
name?string

Name, höchstens 60 Zeichen und eindeutig unter den Kassenbüchern in Gebrauch, etwa „Werkstattkasse“.

numberPrefix?string

Anfang der Nummern seiner Einträge: KB beim ersten Kassenbuch der Firma, bei weiteren KB- und ein Buchstabe.

openingBalanceMinor?integer

Geld in der Kasse zu Beginn von startDate, in Cent, höchstens 100000000 (1.000.000 €).

openingContraAccount?integer

Gegenkonto des Anfangsbestands, beim Anlegen aus Kontenrahmen und Rechtsform bestimmt und danach fest: Privateinlage, Gesellschafter-Verrechnung oder Geldtransit; 0 bei carried_forward. Fehlt bei einem Anfangsbestand von 0.

openingPerson?string

Wer den Anfangsbestand eingelegt hat, bei Herkunft deposit; steht auf dem Eigenbeleg des Anfangsbestands.

openingSource?string

Herkunft des Anfangsbestands: deposit (eigenes Geld des Inhabers bzw. der Gesellschafter), bank (vom Geschäftskonto geholt, als Geldtransit) oder carried_forward (steht schon in der Buchhaltung oder die Steuerberatung bucht den Betrag selbst, bimetrics bucht nichts). Fehlt bei einem Anfangsbestand von 0.

Wert in"deposit""bank""carried_forward"
startDate?

Erster Tag, für den das Kassenbuch den Bestand führt.

updatedAt?string

Letzte Änderung.

Formatdate-time
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-books/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" -X POST \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001"
Beispielantwort
{  "account": 1600,  "archivedAt": "2026-11-13T11:00:00Z",  "balanceMinor": 20000,  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-11-13T09:00:00Z",  "id": "7c2e9a41-5b3d-4f08-9e61-2d8a4c7f1b39",  "kind": "petty",  "name": "Handkasse Büro",  "numberPrefix": "",  "openingBalanceMinor": 20000,  "openingContraAccount": 1460,  "openingSource": "bank",  "startDate": {    "day": 10,    "month": 11,    "year": 2026  },  "updatedAt": "2026-11-13T11:00:00Z"}

Kassenbuch umbenennen PATCH

Ändert den Namen eines Kassenbuchs; alles andere steht fest. `expectedUpdatedAt` ist das gelesene `updatedAt`; hat sich das Kassenbuch seitdem geändert, antwortet die Route mit `409 VersionConflict` und ändert nichts. Ein stillgelegtes Kassenbuch lässt sich nicht mehr umbenennen. Eine ID einer anderen Firma ergibt `404 CashBookNotFound`. Benötigt einen Schlüssel mit der Berechtigung `company:write`.

Monat eines Kassenbuchs lesen GET

Liefert einen Monat des Kassenbuchs: den Bestand davor (`openingMinor`) und danach (`closingMinor`) und die Tage mit Einträgen, je mit Anfangs- und Endbestand. Die Einträge eines Tages stehen in der Reihenfolge ihrer Erfassung. Jeder Eintrag hat eine Nummer, die je Kassenbuch und Jahr lückenlos zählt (`KB-2026-0001`, bei weiteren Kassenbüchern `KB-A-2026-0001`). Einträge werden nie geändert oder gelöscht; ein Fehler wird storniert. Benötigt einen Schlüssel mit der Berechtigung `read`.