FoyerDevelopers

Generated · Live registry

till tools

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

All tool domains

till.addEntry

writes

Till: add entry. Mutation — changes data. See the input schema for argument details.

Input parameters

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

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
entryIdstringyes
sequenceNumberintegeryes

till.balance

read-only

Till: balance. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
totalIncomenumberyes
totalExpensenumberyes
balancenumberyes
todayIncomenumberyes
todayExpensenumberyes
lastEntrystring · nullableyes

till.categories

read-only

Till: categories. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

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

till.closeDay

writesconfirm

Close (festschreiben) the cash book up to a date. Locks the period against further postings and records a chained hash.

Input parameters

FieldTypeRequiredNotes
datestringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
abschlussDatestringyes
incomestringyesDecimal as string — numeric column, not an IEEE-754 double
expensestringyesDecimal as string — numeric column, not an IEEE-754 double
entryCountintegeryes
hashstringyes

till.closings

read-only

Till: closings. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
limitintegernoDefault: 60

Output fields

FieldTypeRequiredNotes
lastClosedDatestring · nullableyes
closingsarray of objectyes
closings.abschlussDatestringyes
closings.incomestringyesDecimal as string — numeric column, not an IEEE-754 double
closings.expensestringyesDecimal as string — numeric column, not an IEEE-754 double
closings.entryCountintegeryes
closings.firstSequenceNumberinteger · nullableyes
closings.lastSequenceNumberinteger · nullableyes
closings.hashstringyes
closings.previousHashstring · nullableyes
closings.createdAtstringyes

till.count

read-only

Till: count. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Returns integer.

till.forDate

read-only

Till: for date. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
datestringyes

Output fields

FieldTypeRequiredNotes
entriesarray of objectyes
entries.idstringyes
entries.sequenceNumberintegeryes
entries.entryDatestringyes
entries.typeenumyesOne of: income, expense
entries.categorystring · nullableyes
entries.descriptionstringyes
entries.amountstringyesDecimal as string — numeric column, not an IEEE-754 double
entries.reservationIdstring · nullableyes
entries.reservationCodestring · nullableyes
entries.guestNamestring · nullableyes
entries.createdAtstringyes
entries.createdByUserIdstring · nullableyes
entries.stornoOfEntryIdstring · nullableyes
entries.storniertbooleanyes
totalsobjectyes
totals.incomenumberyes
totals.expensenumberyes
totals.netnumberyes

till.report

read-only

Till: report. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

FieldTypeRequiredNotes
fromstringyes
tostringyes
totalsobjectyes
totals.incomenumberyes
totals.expensenumberyes
totals.netnumberyes
byCategoryobjectyes
byCategory.incomeobjectyes
byCategory.expenseobjectyes
byDayobjectyes
entriesarray of objectyes
entries.idstringyes
entries.sequenceNumberintegeryes
entries.entryDatestringyes
entries.typeenumyesOne of: income, expense
entries.categorystring · nullableyes
entries.descriptionstringyes
entries.amountstringyesDecimal as string — numeric column, not an IEEE-754 double
entries.reservationIdstring · nullableyes
entries.reservationCodestring · nullableyes
entries.guestNamestring · nullableyes
entries.createdAtstringyes
entries.createdByUserIdstring · nullableyes
entries.stornoOfEntryIdstring · nullableyes
entries.storniertbooleanyes

till.stornoEntry

writesconfirm

Reverse a cash-book (Kassenbuch) entry by booking a counter-entry. Nothing is deleted — the ledger is append-only (GoBD).

Input parameters

FieldTypeRequiredNotes
idstringyes
reasonstringyes
confirmliteralyesOne of: true

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
stornoEntryIdstringyes
sequenceNumberintegeryes
entryDatestringyes

till.today

read-only

Till: today. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
entriesarray of objectyes
entries.idstringyes
entries.sequenceNumberintegeryes
entries.entryDatestringyes
entries.typeenumyesOne of: income, expense
entries.categorystring · nullableyes
entries.descriptionstringyes
entries.amountstringyesDecimal as string — numeric column, not an IEEE-754 double
entries.reservationIdstring · nullableyes
entries.reservationCodestring · nullableyes
entries.guestNamestring · nullableyes
entries.createdAtstringyes
entries.createdByUserIdstring · nullableyes
entries.stornoOfEntryIdstring · nullableyes
entries.storniertbooleanyes
totalsobjectyes
totals.incomenumberyes
totals.expensenumberyes
totals.netnumberyes
countintegeryes

till.verifyChain

read-only

Till: verify chain. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
okbooleanyes
checkedintegeryes
brokenarray of objectyes
broken.abschlussDatestringyes
broken.grundenumyesOne of: hash_mismatch, chain_mismatch
broken.erwartetstringyes
broken.gefundenstringyes