FoyerDevelopers

Generated · Live registry

reports tools

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

All tool domains

reports.buchungenPreise

read-only

Bookings and prices: per booking and room, nights, booking date, paid average price per night, and the calendar price on the booking date together with the difference. Read-only query.

Input parameters

FieldTypeRequiredNotes
anreiseVonstringyes
anreiseBisstringyes
buchungVonstringno
buchungBisstringno
roomstringno

Output fields

FieldTypeRequiredNotes
anreiseVonstringyes
anreiseBisstringyes
ersterVerlaufstagstringyes
aufenthalteintegeryes
zeilenarray of objectyes
zeilen.stayIdstringyes
zeilen.buchungsnummerstring · nullableyes
zeilen.kanalstring · nullableyes
zeilen.zimmerstring · nullableyes
zeilen.anreisestringyes"YYYY-MM-DD" (UTC-Kalendertag wie die Nächtezählung).
zeilen.abreisestringyes
zeilen.naechteintegeryes
zeilen.gebuchtAmstring · nullableyesBuchungstag "YYYY-MM-DD" in der Hauszone; null = unbekannt.
zeilen.gebuchtQuelleenum · nullableyesOne of: kanal, beds24, foyer
zeilen.bezahltCentsinteger · nullableyes
zeilen.bezahltQuelleenum · nullableyesunterkunft = Unterkunftssumme ohne Gebühren (mit dem Kalenderpreis vergleichbar); gesamt = Gesamtbetrag inkl. Gebühren; zimmerpreis = Beds24-Zimmerpreis inkl. Ortssteuer. — One of: unterkunft, gesamt, zimmerpreis
zeilen.bezahltAnteiligbooleanyes
zeilen.zimmerUrspruenglichstring · nullableyes
zeilen.bezahltProNachtCentsinteger · nullableyesØ je Nacht.
zeilen.angebotCentsinteger · nullableyes
zeilen.naechteMitAngebotintegeryes
zeilen.angebotProNachtCentsinteger · nullableyes
zeilen.differenzCentsinteger · nullableyes
zeilen.differenzProNachtCentsinteger · nullableyes

reports.revenue_stats

read-only

Revenue + occupancy KPIs over a 7/30/90-day window: occupancy %, ADR, RevPAR, total revenue (cents), a daily revenue series, and a per-room-type breakdown. Read-only. Revenue is sourced from folio_lines (Foyer-native authoritative). stornoErloese = cancellations where the channel kept money (count + cents): the amount the guest paid according to the channel, GROSS like the rest of revenue (Airbnb: Beds24 Channel Collect + channel commission, capped at the reported price; Booking.com: reported payment, else cancellation fee, without commission — Booking.com bills it separately), the fee itself carries 0% VAT (non-taxable damages) — NOT the payout. Assigned by check-in date and NOT included in revenue, ADR, RevPAR or occupancy. stornogebuehrImUmsatzCents = cancellation fees of LIVE stays (one room of a multi-room booking cancelled): included in revenueTotal and the daily series, but subtracted from the ADR/RevPAR numerator (overall and per room type) — a fee is not a sold room.

Input parameters

FieldTypeRequiredNotes
windowDaysliteralyes

Output fields

FieldTypeRequiredNotes
windowDaysnumberyes
totalRoomsnumberyes
occupiedNightsnumberyes
availableNightsnumberyes
occupancyPctnumberyes
revenueTotalnumberyes
adrnumberyes
revparnumberyes
stornogebuehrImUmsatzCentsnumberyes
dailySeriesarray of objectyes
dailySeries.datestringyes
dailySeries.revenueCentsnumberyes
byRoomTypearray of objectyes
byRoomType.roomTypestringyes
byRoomType.displayNamestringyes
byRoomType.roomCountnumberyes
byRoomType.occupiedNightsnumberyes
byRoomType.availableNightsnumberyes
byRoomType.occupancyPctnumberyes
byRoomType.revenueCentsnumberyes
byRoomType.adrnumberyes
byRoomType.revparnumberyes
stornoErloeseobjectyes
stornoErloese.anzahlnumberyes
stornoErloese.summeCentsnumberyes

reports.summary

read-only

Report overview of the property: bookings and occupancy per month, booking sources, AI shifts, send counters of the messaging rules, and cleaning tasks (total and completed). Requires the finances module. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
generatedAtstringyes
bookingsarray of objectyes
bookings.monthstringyesISO month start, e.g. "2026-04-01".
bookings.labelstringyesHuman label, e.g. "Apr 26".
bookings.countintegeryes
occupancyarray of objectyes
occupancy.monthstringyesISO month start, e.g. "2026-04-01".
occupancy.labelstringyesHuman label, e.g. "Apr 26".
occupancy.occupiedNightsintegeryes
occupancy.availableNightsintegeryes
occupancy.pctnumberyes
sourcesarray of objectyes
sources.sourcestringyes
sources.countintegeryes
aiLayersarray of objectyes
aiLayers.layerstringyes
aiLayers.countintegeryes
autoReplyRatenumberyesShare (0..1) of inbound guest messages in the last 30 days answered by a rule|llm message within 24 h — the same definition as dashboard.aiAnalytics.autoReplyRate.
messagingRulesarray of objectyes
messagingRules.idstringyes
messagingRules.namestringyes
messagingRules.enabledbooleanyes
messagingRules.sentCountintegeryes
messagingRules.lastSentAtstring · nullableyes
cleaningobjectyes
cleaning.daysBackintegeryes
cleaning.totalTasksintegeryes
cleaning.completedintegeryes
cleaning.skippedintegeryes
cleaning.pendingintegeryes
cleaning.inProgressintegeryes
cleaning.avgDurationMinutesinteger · nullableyes
cleaning.completionPctnumberyes