FoyerDevelopers

Generated · Live registry

kassenbuch tools

8 tools in this domain, generated from the running registry.

All tool domains

kassenbuch.add_entry

writesconfirm

Add a single cash entry (income or expense) to the ledger. Type is 'income' or 'expense' (note: English, not 'einnahme'/'ausgabe'). If entryDate is omitted, today is used. amount must be > 0. reservationId links the entry to a stay UUID; reservationCode is the human-readable booking code (e.g. 'HM54KEHW5X'). Mutating — requires _confirm: true.

Input parameters

FieldTypeRequiredNotes
typeenumyesOne of: income, expense
descriptionstringyes
amountnumberyes
categorystringyes
entryDatestringno
reservationIdstring · nullableno
reservationCodestring · nullableno
guestNamestring · nullableno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
entryIdstringyes
sequenceNumbernumberyes

kassenbuch.balance

read-only

Aggregate cash-book balance: total income + expense over all-time, today's income + expense subtotal, and the timestamp of the most-recent entry. Use for 'wie viel ist drin?' summaries. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
total_incomenumberyes
total_expensenumberyes
today_incomenumberyes
today_expensenumberyes
last_entrystring · nullableyes

kassenbuch.categories

read-only

Valid income + expense category labels accepted by the cash-book. Pre-context for any add-entry prompt — pick from these values. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
incomearray of objectyes
income.valuestringyes
income.labelstringyes
expensearray of objectyes
expense.valuestringyes
expense.labelstringyes

kassenbuch.closings

read-only

List the cash book's day-closings (Tagesabschlüsse / Festschreibung). Each closing locks every entry up to its date and carries a SHA-256 hash chained to the previous one, so a later change to a locked period is detectable. Read-only.

Input parameters

FieldTypeRequiredNotes
limitintegernoDefault: 60

Output fields

FieldTypeRequiredNotes
lastClosedDatestring · nullableyes
closingsarray of objectyes
closings.abschlussDatestringyes
closings.incomestringyes
closings.expensestringyes
closings.entryCountintegeryes
closings.hashstringyes
closings.previousHashstring · nullableyes

kassenbuch.list_for_date

read-only

Cash-book entries for a single date (YYYY-MM-DD). Read-only. Useful for 'was war am 15.04.?' lookups.

Input parameters

FieldTypeRequiredNotes
datestringyes

Output fields

FieldTypeRequiredNotes
entriesarrayyes

kassenbuch.list_today

read-only

Today's cash-book entries plus aggregated income / expense / net total for the day. Date is computed against the server's CURRENT_DATE (UTC in the DB; convert to Europe/Berlin client-side if needed). Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
entriesarrayyes
totalsobjectyes
totals.incomenumberyes
totals.expensenumberyes
totals.netnumberyes

kassenbuch.report

read-only

Cash-book report for a date range (from/to inclusive, YYYY-MM-DD). Returns per-category breakdowns + period totals. Read-only.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

An object keyed by string. Each value is any.

kassenbuch.storno_entry

writesconfirm

Reverse a cash entry by booking a COUNTER-ENTRY (German GoBD: the cash book is append-only, nothing is ever deleted). The original row stays; a new row with the inverted type, the same amount and a mandatory reason cancels it out. Booked to the first open day — never into a period that has already been locked by a day-closing. Mutating — requires _confirm: true.

Input parameters

FieldTypeRequiredNotes
entryIdstringyes
reasonstringyesWhy the entry is being reversed. Goes into the journal.

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
stornoEntryIdstringyes
sequenceNumberintegeryes
entryDatestringyes