FoyerDevelopers

Generated · Live registry

city_tax tools

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

All tool domains

city_tax.get

read-only

Read the current tenant's accommodation-tax (Beherbergungssteuer / Kurtaxe / city tax) configuration. Fields: enabled, label, method (per_booking | per_night | per_person_booking | per_person_night | percent_total), flatCents (€ amount ×100, for the flat methods), percent (for percent_total), vatRatePct, maxNights (taxable-nights cap, null = none), adultsOnly (children exempt), includedInTotal (carve out of the booking total vs. add on top). Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
enabledbooleanyes
labelstringyes
methodenumyesOne of: per_booking, per_night, per_person_booking, per_person_night, percent_total
flatCentsnumberyes
percentstringyes
vatRatePctstringyes
maxNightsnumber · nullableyes
adultsOnlybooleanyes
includedInTotalbooleanyes

city_tax.update

writes

Upsert the tenant's accommodation-tax config. `method` selects how the tax is computed: per_booking (flat per booking), per_night (flat × nights), per_person_booking (flat × persons), per_person_night (flat × persons × nights), or percent_total (percent of the booking total). `amountEur` is the € amount for the flat methods; `percent` is used for percent_total. `maxNights` caps taxable nights (null = no cap). `adultsOnly` exempts children. `includedInTotal` carves the tax out of the booking total instead of adding it on top. Owner-only.

Input parameters

FieldTypeRequiredNotes
enabledbooleanyes
labelstringyes
methodenumyesOne of: per_booking, per_night, per_person_booking, per_person_night, percent_total
amountEurnumberyes€ amount for the flat methods.
percentnumberyesPercent for method=percent_total.
vatRatePctnumberyes
maxNightsinteger · nullableyes
adultsOnlybooleanyes
includedInTotalbooleanyes

Output fields

FieldTypeRequiredNotes
okbooleanyes