bimetricsEntwickler
Kassenbuch

Kassenbuch ein- oder ausschalten

Als Markdown ansehen

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

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
put/api/settings/cash-book

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

Schaltet das Kassenbuch für die Firma ein oder aus, wie der Schalter „Kassenbuch verwenden“ in den Einstellungen. Eingeschaltet sieht das ganze Team den Menüpunkt Kassenbuch. Ausschalten geht erst, wenn kein Kassenbuch mehr in Gebrauch ist, sonst 409 CashBookRejected. Nur ein Inhaber darf schalten, sonst 403 CashBookOwnerOnly. Bei einer Wiederholung schickst du denselben Idempotency-Key.

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.

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

on or off

application/json
  1. body

Kassenbuch ein- oder ausschalten.

enabled?boolean

true schaltet das Kassenbuch ein, false aus.

Antworten

Erfolg.

application/json
  1. response

Ob die Firma das Kassenbuch verwendet und was der Aufrufer damit darf.

accounts?array<integer>|

Kassenkonten, die ein neues Kassenbuch nehmen kann, das nächste freie zuerst; leer, wenn drei Kassenbücher in Gebrauch sind.

ask?boolean

true, solange die App den Inhaber in „Erste Schritte“ fragt, ob die Firma eine Kasse mit Bargeld hat. Gefragt werden nur Firmen, die sich registriert haben, seit es das Kassenbuch gibt; bei älteren bleibt das Feld false. Die Frage entfällt, sobald ein Inhaber das Kassenbuch ein- oder ausschaltet.

canBook?boolean

true für Inhaber und Nutzer: Sie dürfen buchen und stornieren, im Kassenbuch und mit „Bar“ am Beleg. Die Steuerberatung liest nur.

canChange?boolean

true für Inhaber: Sie dürfen das Kassenbuch ein- und ausschalten und Kassenbücher anlegen, umbenennen und stilllegen.

deposit?string

Wie eine Einlage in die Kasse gebucht wird: owner als Privateinlage, shareholder über das Gesellschafter-Verrechnungskonto. Leer, wenn die Rechtsform fehlt oder keine Einlage kennt.

enabled?boolean

true, wenn die Firma das Kassenbuch verwendet; die App zeigt dann den Menüpunkt Kassenbuch.

inUse?integer

Zahl der Kassenbücher, die nicht stillgelegt sind. Solange es eins gibt, lässt sich das Kassenbuch nicht ausschalten.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/settings/cash-book" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "accounts": [    1600,    1610,    1620  ],  "ask": false,  "canBook": true,  "canChange": true,  "deposit": "shareholder",  "enabled": true,  "inUse": 0}