bimetricsEntwickler
Kassenbuch

Kassenbuch-Einstellung lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/settings/cash-book

Sagt, ob die Firma das Kassenbuch verwendet (enabled), ob der Schlüssel bzw. die Person es ändern darf (canChange, nur Inhaber) und darin buchen darf (canBook, nicht die Steuerberatung), wie viele Kassenbücher in Gebrauch sind (inUse) und welche Kassenkonten ein neues Kassenbuch nehmen kann (accounts, das nächste freie zuerst). deposit sagt, 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.

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.

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"
Beispielantwort
{  "accounts": [    1610,    1620  ],  "ask": false,  "canBook": true,  "canChange": true,  "deposit": "shareholder",  "enabled": true,  "inUse": 1}