FoyerDevelopers

Generated · Live registry

stays tools

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

All tool domains

stays.aenderungen

read-only

The change history of ONE booking: who touched which field and when. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
limitintegernoDefault: 50

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
actionstringyes
createdAtstringyes
akteurstring · nullableyes
aenderungenarray of objectyes
aenderungen.feldstringyes
aenderungen.vorherstring · nullableyes
aenderungen.nachherstring · nullableyes
folioobject · nullableyes
folio.zeilennumberyes
folio.summeCentsnumberyes
herkunftstring · nullableyes

stays.anfrageZimmer

read-only

Is the room of an open request now occupied, and which room of the same category would be free for the whole period? `null` if the stay is not an open request. `gleicherPreis` per room: the same room prices on every night and in every rate plan. Operations roles only. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
zimmerstringyes
kategoriestring · nullableyes
checkInstringyes
checkOutstringyes
belegteNaechtearray of stringyes
freiarray of objectyes
frei.zimmerIdstringyes
frei.namestringyes
frei.gleicherPreisbooleanyes
preisCentsnumber · nullableyes
kanalBetragCentsnumber · nullableyes
gebuehrSatznumber · nullableyes
waehrungstringyes
vornamestring · nullableyes
plattformstring · nullableyes

stays.anreisenOhneTelefon

read-only

Booking.com arrivals from today to the day after tomorrow without a phone number, each with a link to the booking's extranet page. Since 28 Sep 2026 Booking.com no longer passes the number on to Beds24; without it the WhatsApp template of the check-in instructions cannot reach the guest. Operations roles only (names); others get an empty list. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
hotelIdFehltbooleanyes
anreisenarray of objectyes
anreisen.stayIdstringyes
anreisen.hrefstringyes
anreisen.roomstring · nullableyes
anreisen.checkInstring · nullableyes
anreisen.gaststring · nullableyes
anreisen.buchungsnummerstring · nullableyes
anreisen.extranetLinkstring · nullableyes

stays.aufEinenBlick

read-only

The booking at a glance for the head of the thread: summary, the figures paid, on site, arrival and check-in from, open items with a jump target and at most one contradiction notice — texts as keys with values. Once the arrival is confirmed, also `aufenthalt`: one point per night up to check-out, with the messages and requests of each day and the check-out reminder. Operator roles only, otherwise `null`. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
saetzearray of objectyes
saetze.schluesselstringyes
saetze.werteobjectyes
saetze.rohobjectno
chipsarray of objectyes
chips.artenumyesOne of: bezahlt, vor_ort, ankunft, angekommen, checkin_ab
chips.wertstring · nullableyes
chips.tonenumyesOne of: gruen, neutral, hinweis
chips.rohobjectno
bezahltDetailobject · nullableyes
bezahltDetail.schluesselstringyes
bezahltDetail.werteobjectyes
bezahltDetail.rohobjectno
punktearray of objectyes
punkte.artenumyesOne of: anliegen, online_checkin, vorfall, fehlgeschlagen
punkte.titelobjectyes
punkte.unterzeileobject · nullableyes
punkte.zielstring · nullableyes
punkte.kuemmertSichobject · nullableno
punkte.queueIdstringno
widerspruchobject · nullableyes
widerspruch.textobjectyes
widerspruch.zielstringyes
widerspruch.messageIdstringyes
kurzarray of objectyes
kurz.schluesselstringyes
kurz.werteobjectyes
kurz.rohobjectno
stationenarray of objectyes
stationen.idstringyes
stationen.artenumyesOne of: buchung, extra, online_checkin, zugang, anreise, abreise, storno
stationen.zeitstringyes
stationen.statusenumyesOne of: fertig, problem, jetzt, geplant
stationen.zielstring · nullableyes
stationen.detailobject · nullableyes
stationen.hinweisobject · nullableyes
anliegenMarkerarray of objectyes
anliegenMarker.zeitstringyes
anliegenMarker.titelstringyes
anliegenMarker.zielstring · nullableyes
jetztstringyes
angekommenAmstring · nullableyes
phaseenumyesOne of: anfrage, vor_anreise, im_haus, abgereist, storniert
nachrichtenarray of objectyes
nachrichten.idstringyes
nachrichten.titelstringyes
nachrichten.zeitstringyes
nachrichten.statusenumyesOne of: gesendet, geplant, ausgelassen, fehlgeschlagen
nachrichten.zielstring · nullableyes
zielobject · nullableyes
ziel.stationenarray of objectyes
ziel.erreichtbooleanyes
ziel.jetztNachenum · nullableyesOne of: buchung, bestaetigung, portal, code, eingecheckt
ziel.codeUebergebenobject · nullableyes
ziel.portalStandobject · nullableyes
aufenthaltobject · nullableyes
aufenthalt.naechtearray of objectyes
aufenthalt.checkoutobjectyes
aufenthalt.heuteNachtinteger · nullableyes
aufenthalt.zimmerarray of objectyes

stays.booking-panel

read-only

Read-only assembly of a booking's two inbox side-panels: reservation summary, guest, mapped property (address/rules/capacity), host+guest financial breakdown, messaging activity, and linked tasks. Returns null if the stay does not exist. Read-only.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
reservationobjectyes
reservation.codestring · nullableyes
reservation.platformstring · nullableyes
reservation.statusstringyes
reservation.otaStatusstring · nullableyes
reservation.roomstring · nullableyes
reservation.roomNamestring · nullableyes
reservation.checkInstring · nullableyes
reservation.checkOutstring · nullableyes
reservation.expectedArrivalAtstring · nullableyes
reservation.expectedArrivalQuellestring · nullableno
reservation.nightsnumber · nullableyes
reservation.guestsCountnumber · nullableyes
reservation.adultsnumber · nullableyes
reservation.childrennumber · nullableyes
reservation.infantsnumber · nullableyes
reservation.petsnumber · nullableyes
reservation.totalFormattedstring · nullableyes
reservation.exConversationIdstring · nullableyes
reservation.externalRefstring · nullableyes
guestobjectyes
guest.namestring · nullableyes
guest.emailstring · nullableyes
guest.phonestring · nullableyes
guest.localestring · nullableyes
guest.locationstring · nullableyes
guest.sameDayBookingbooleanyes
guest.bookingDatestring · nullableyes
propertyobject · nullableyes
property.addressDisplaystring · nullableyes
property.wifiNamestring · nullableyes
property.wifiPasswordstring · nullableyes
property.maxGuestsnumber · nullableyes
property.petsAllowedboolean · nullableyes
property.smokingAllowedboolean · nullableyes
property.eventsAllowedboolean · nullableyes
financialsobjectyes
financials.currencystringyes
financials.hostarray of objectyes
financials.guestarray of objectyes
financials.kanalHinweisobject · nullableyes
financials.vorOrtobject · nullableno
activityarray of objectyes
activity.ruleNamestring · nullableyes
activity.statusstringyes
activity.atstring · nullableyes
tasksarray of objectyes
tasks.idstringyes
tasks.kindstringyes
tasks.statusstringyes
tasks.scheduledForstring · nullableyes
tasks.titlestring · nullableyes
tasks.quelleenumyesOne of: reinigung, aufgabe

stays.byId

read-only

Get full detail for a single stay/reservation by id.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
guestIdstringyes
externalRefstring · nullableyes
externalCodestring · nullableyes
sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice, channex, beds24
checkInstring · nullableyes
checkOutstring · nullableyes
roomstring · nullableyes
statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
otaStatusstring · nullableyes
bookingDatestring · nullableyes
issueAlertstring · nullableyes
stayTypestring · nullableyes
notesstring · nullableyes
createdAtstringyes
paymentIntentIdstring · nullableyes
paymentStatusstring · nullableyes
bookingTotalCentsinteger · nullableyes
currencyCodestring · nullableyes
expectedArrivalAtstring · nullableyes
folioClosedstring · nullableyes
holdExpiresAtstring · nullableyes
sourcestring · nullableyes
guestsCountinteger · nullableyes
adultsinteger · nullableyes
childreninteger · nullableyes
infantsinteger · nullableyes
petsinteger · nullableyes
nightsinteger · nullableyes
otaSourcestring · nullableyes
otaReservationIdstring · nullableyes
guestNamestring · nullableyes
bookingStaysarray of objectyes
bookingStays.idstringyes
bookingStays.roomstring · nullableyes
bookingRoomsarray of stringyes
chatStayIdstringyes
exConversationIdstring · nullableyes

stays.cancel_and_refund

writesconfirm

Cancel a DIRECT (Stripe) booking and refund per the cancellation-window policy. forceRefund=true issues an operator courtesy refund of the FULL amount paid regardless of the window. Only direct bookings with a payment can be refunded here. Bookings made with booking terms (stays.stornoVorschlag → hatSchnappschuss=true) refund ONLY the amount passed as erstattungCents (cents, 0 = deliberately no refund, at most the amount paid — call stays.stornoVorschlag FIRST and pass its vorschlagCents or deviate deliberately). If such a booking was paid via Stripe and its proposal is above 0, omitting both erstattungCents and forceRefund is REFUSED (PRECONDITION_FAILED, message starts with 'erstattungsbetrag_erforderlich:<vorschlagCents>:') and nothing changes. Owner-only, IRREVERSIBLE, requires confirmation.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
forceRefundbooleannoDefault: false
erstattungCentsintegerno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
refundedbooleanyes
refundIdstring · nullableyes
windowHoursnumberyes
eligibleByPolicybooleanyes
erstattungCentsintegeryes
vorschlagCentsinteger · nullableyes
grundstringyes
hatSchnappschussbooleanyes

stays.cardDetail

read-only

Rich payload for the calendar booking quick-card. Joins the guest's contact details and returns the OTA financials + headcount so the card can mirror Hospitable's reservation card (confirmation code, arrival/ departure times, nights, price, guest breakdown, contact). Lazily fetched when a bar is clicked — keeps `forWindow` lightweight. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
roomstring · nullableyes
statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
otaStatusstring · nullableyes
sourcestring · nullableyes
plattformEtikettstring · nullableyes
sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice, channex, beds24
externalCodestring · nullableyes
externalRefstring · nullableyes
otaSourcestring · nullableyes
otaReservationIdstring · nullableyes
lokalerVorrangAmstring · nullableyes
kanalAbgleichStandstring · nullableyes
kanalAbgleichFehlerstring · nullableyes
checkInstring · nullableyes
checkOutstring · nullableyes
expectedArrivalAtstring · nullableyes
nightsinteger · nullableyes
bookingTotalCentsinteger · nullableyes
currencyCodestring · nullableyes
adultsinteger · nullableyes
childreninteger · nullableyes
infantsinteger · nullableyes
petsinteger · nullableyes
guestsCountinteger · nullableyes
paymentStatusstring · nullableyes
guestIdstringyes
guestNamestring · nullableyes
guestEmailstring · nullableyes
guestPhonestring · nullableyes
localestring · nullableyes
exConversationIdstring · nullableyes
bookingRoomsarray of stringyes

stays.checkoutZuruecknehmbar

read-only

Can an automatic check-out (departure message, announced early departure, accepted suggestion) be undone? Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
zuruecknehmbarbooleanyes

stays.checkoutZuruecknehmen

writes

“Check back in”: undoes an automatic check-out. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.codeUebergeben

writes

Mark that reception handed the guest the front-door code in person — for bookings without a contact channel. Counts as the goal station “code delivered”. Set once; a second call does not change the timestamp; no undo, the change log records who and when. Rejected for cancelled stays and when access is blocked. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes
codeUebergebenAmstringyes

stays.createWalkIn

writes

Create a walk-in booking directly (no OTA) — for a guest arriving without a prior reservation.

Input parameters

FieldTypeRequiredNotes
guestNamestringyes
guestEmailstringno
guestPhonestringno
roomstringno
checkinDatestringyes
checkoutDatestringyes
notesstringno
totalCentsintegerno

Output fields

FieldTypeRequiredNotes
stayIdstringyes

stays.create_booking

writesconfirm

Create a booking: inserts a guest and a stay. Dates are YYYY-MM-DD; checkout must be after check-in. If status='checked_in', the smart-lock check-in lifecycle fires. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
guestNamestringyes
guestEmailstringno
guestPhonestringno
roomstringno
checkinDatestringyes
checkoutDatestringyes
statusenumnoOne of: confirmed, pending, checked_in — Default: "confirmed"
sourceenumnoOne of: direct, booking, airbnb, manual — Default: "manual"
totalCentsintegerno

Output fields

FieldTypeRequiredNotes
stayIdstringyes

stays.forWindow

read-only

List stays overlapping a given date window, for calendar/occupancy-style views.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
checkInstring · nullableyes
checkOutstring · nullableyes
roomstring · nullableyes
statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
otaStatusstring · nullableyes
bookingDatestring · nullableyes
createdAtstringyes
sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice, channex, beds24
sourcestring · nullableyes
plattformEtikettstring · nullableyes
guestNamestring · nullableyes
otaReservationIdstring · nullableyes
otaSourcestring · nullableyes
exConversationIdstring · nullableyes
externalRefstring · nullableyes
roomsarray of stringyes
hasRoomOverridebooleanyes
originalRoomsarray of stringyes

stays.gastAngabeSetzen

writes

Set the guest's country and/or language by hand, in "Über den Gast" (About the guest). Per field: omitted = unchanged, `null` = back to "automatic", a code = set. Country: `guests.land_von_hand`, takes precedence over registration form, booking and dialling code. Language: writes `guests.locale` (portal, templates and reminders follow it) AND `sprache_von_hand_am`, which blocks the imports; "automatic" only clears the timestamp, `locale` stays. Attached to the stay's GUEST. Trace in audit_log. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
landstring · nullableno
sprachestring · nullableno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.gastAuswertungWiderspruch

writes

The guest objects to the analysis of their messages for improving Foyer (Art. 21 GDPR; DPA Annex 3 para. 8). Their messages no longer enter the review set, and existing excerpts are deleted immediately. `aufheben: true` withdraws an objection entered by mistake. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
aufhebenbooleannoDefault: false

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
geloeschtintegeryes

stays.gastEmailUebernehmen

writes

Adopt an email address from a guest message, like `gastTelefonUebernehmen`: one click below the message, never automatic; only what the detection finds in THIS incoming message itself is adopted. The address becomes the valid one; the previous one is kept in `weitere_email`. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
messageIdstringyes
emailstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
emailstringyes
geaendertbooleanyes

stays.gastInfo

read-only

The "Über den Gast" (About the guest) panel: country, language, WhatsApp, reported problems, stated arrival time, each with its source, so that a guess (dialing code, detected language) does not look like a stated fact. Also "online check-in stuck": an error in the guest portal or an online check-in that was started but not finished, otherwise `null`. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
landstring · nullableyes
landQuelleenum · nullableyesOne of: hand, meldeschein, buchung, vorwahl
sprachestring · nullableyes
spracheQuelleenum · nullableyesOne of: hand, buchung, nachrichten, vorwahl
waNummerstring · nullableyes
waKontoobject · nullableyes
waKonto.statusenumyesOne of: hat, kein
waKonto.quelleenumyesOne of: meta, betreiber
waKonto.bisstring · nullableyes
notizobject · nullableyes
notiz.textstringyes
notiz.aktualisiertAmstring · nullableyes
hatteProblemebooleanyes
problemearray of stringyes
problemVomGastErledigtAmstring · nullableyes
problemErledigtobject · nullableyes
problemErledigt.amstringyes
problemErledigt.quelleenumyesOne of: gast, ki, manuell
problemErledigt.vonstring · nullableyes
ankunftLautGaststring · nullableyes
buchungobject · nullableyes
buchung.landstring · nullableyes
buchung.ortstring · nullableyes
buchung.firmastring · nullableyes
buchung.ankunftobject · nullableyes
buchung.vorausbezahltbooleanyes
buchung.hinweisearray of stringyes
firmaLautNachrichtstring · nullableyes
auswertungWiderspruchAmstring · nullableyes
telefonVonBookingVorenthaltenbooleanyes
portalHaengtobject · nullableyes

stays.gastKontaktSetzen

writes

Manually enter the guest's email address or phone number, directly in "Über den Gast" (About the guest). The new value becomes the VALID one: invoice, portal link and rule emails go there, and WhatsApp to the number. The previous one (usually the channel's forwarding address, e.g. `…@guest.booking.com`) is kept in `weitere_email` / `weitere_telefon`. A national number ("06 12345678") is interpreted by the rule of the guest's country (`inlandsnummerZuE164`, around 30 countries; unknown… Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
artenumyesOne of: email, telefon
wertstringyes
quelleenumnoOne of: faden, extranet — Default: "faden"

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
wertstringyes
geaendertbooleanyes
gesichertbooleanyes

stays.gastNotizSetzen

writes

Note about the guest across bookings, e.g. "ruhiges Zimmer gewünscht" (quiet room requested), "hat Schimmel gemeldet" (reported mold). Attached to the stay's GUEST; every future booking shows it. Empty text deletes it. Trace in audit_log. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
notizstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.gastTelefonUebernehmen

writes

Adopt a phone number from a guest message as the WhatsApp number (2026-10-10, after Booking.com stopped providing phone numbers on 2026-09-28): the guest writes it in the chat, the operator adopts it with one click. Writes `guests.canonical_phone`, the same place and normalization as the guest portal; the sender finds it afterwards (no more `kein_telefon`) — and since 2026-11-13 it also records the guest's WhatsApp consent. Only what the detection finds in THIS incoming message itself is adopted… Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
messageIdstringyes
nummerstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
nummerstringyes
geaendertbooleanyes
ersetztbooleanyes

stays.get

read-only

Fetch a single stay with its guest details and a summary of the linked conversation (message count, last-message timestamp, conversation id). Read-only.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
stayobject · nullableyes
stay.idstringyes
stay.guestIdstringyes
stay.externalRefstring · nullableyes
stay.sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice
stay.checkInstring · nullableyes
stay.checkOutstring · nullableyes
stay.roomstring · nullableyes
stay.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
guestobject · nullableyes
guest.idstringyes
guest.canonicalEmailstring · nullableyes
guest.canonicalPhonestring · nullableyes
guest.nameHintstring · nullableyes
guest.localestring · nullableyes
conversationobject · nullableyes
conversation.idstringyes
conversation.openedAtstringyes
conversation.lastMessageAtstring · nullableyes
conversation.messageCountintegeryes

stays.list

read-only

List stays/reservations, optionally filtered (date range, guest, status).

Input parameters

FieldTypeRequiredNotes
filterenumnoOne of: today, upcoming, past, all, voice-holds — Default: "all"
limitintegernoDefault: 50
offsetintegernoDefault: 0
guestIdstringno
searchstringno

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
checkInstring · nullableyes
checkOutstring · nullableyes
roomstring · nullableyes
statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice, channex, beds24
guestNamestring · nullableyes
guestEmailstring · nullableyes
guestPhonestring · nullableyes
otaSourcestring · nullableyes
otaReservationIdstring · nullableyes
exConversationIdstring · nullableyes
externalRefstring · nullableyes
roomsarray of stringyes
roomCountintegeryes

stays.list_active

read-only

List stays whose check_out is today or later. Includes pending and confirmed. Read-only.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
itemsarray of objectyes
items.idstringyes
items.guestIdstringyes
items.externalRefstring · nullableyes
items.sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice
items.checkInstring · nullableyes
items.checkOutstring · nullableyes
items.roomstring · nullableyes
items.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold

stays.list_for_guest

read-only

List other stays of a single guest at this tenant, newest-first. excludeStayId is the current stay (so a returning-guest prompt can skip the active visit and focus on history). Read-only.

Input parameters

FieldTypeRequiredNotes
guestIdstringyes
excludeStayIdstringyes

Output fields

FieldTypeRequiredNotes
itemsarray of objectyes
items.idstringyes
items.guestIdstringyes
items.externalRefstring · nullableyes
items.sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice
items.checkInstring · nullableyes
items.checkOutstring · nullableyes
items.roomstring · nullableyes
items.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold

stays.perform_checkout

writesconfirm

Check out a stay: sets status → checked_out, emits the stay.checked_out webhook, nudges the channel availability sync (Beds24/Hospitable) so freed nights reopen, schedules the post-stay review request, and revokes any smart-lock codes. Idempotent if already checked out. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.prior_stays

read-only

List a guest's prior stays, newest-first. Optionally exclude a stayId (the current one). Read-only.

Input parameters

FieldTypeRequiredNotes
guestIdstringyes
excludeStayIdstringno

Output fields

FieldTypeRequiredNotes
itemsarray of objectyes
items.idstringyes
items.guestIdstringyes
items.externalRefstring · nullableyes
items.sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice
items.checkInstring · nullableyes
items.checkOutstring · nullableyes
items.roomstring · nullableyes
items.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold

stays.problemErledigt

writes

"Mark as resolved" in the guest panel: closes everything the guest has reported so far, every category — the review request can go out again, and the red badge becomes the grey line "resolved by <staff member>". A later new problem counts again. Operator roles only. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
geaendertbooleanyes

stays.problemWiederOeffnen

writes

Reverts a resolution made via the button or by the AI — the problem counts as open again. A resolution the guest reported themselves with a short phrase stays (it is in their message). Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true
aufgehobenintegeryes

stays.protokoll

read-only

The log across ALL bookings: the audit view. Read-only query.

Input parameters

FieldTypeRequiredNotes
limitintegernoDefault: 100
vorstringno

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
actionstringyes
createdAtstringyes
akteurstring · nullableyes
stayIdstring · nullableyes
gaststring · nullableyes
zimmerstring · nullableyes
anzahlAenderungennumberyes

stays.rechnungsFortschritt

read-only

Invoice requests of this booking with the guest message they belong to and their progress in five stages (requested, form sent, billing details filled in, invoice created, invoice sent). Also recognised guest invoice requests without a request of their own (`anfrageId: null`) and requests without a matching guest message (`messageId: null`). Operator roles only, otherwise empty. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
anfrageIdstring · nullableyes
messageIdstring · nullableyes
stationenarray of objectyes
stationen.artenumyesOne of: angefragt, formular, ausgefuellt, erstellt, versendet
stationen.statusenumyesOne of: fertig, naechste, offen, abgelehnt
stationen.zeitstring · nullableyes
formularMessageIdstring · nullableyes
formularLinkstring · nullableyes
rechnungobject · nullableyes
rechnung.idstringyes
rechnung.nummerstring · nullableyes
rechnung.urlstring · nullableyes
rechnungVorAbgabeobject · nullableno
rechnungVorAbgabe.idstringyes
rechnungVorAbgabe.nummerstring · nullableyes
rechnungVorAbgabe.urlstring · nullableyes
trefferstring · nullableyes

stays.rechnungsVerlauf

read-only

History of the invoice request for the left panel. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
zeitstringyes
artenumyesOne of: perk_anfrage, perk_nachfrage, daten_eingegangen, status, ausgestellt, versand_geplant, versendet, gestoppt
textstring · nullableyes
inhaltstringno

stays.reset-all-room-overrides

writesconfirm

Clear ALL room-swap overrides for this tenant, restoring every swapped booking to its originally booked room(s). Swaps whose booked room is occupied by another guest stay in place (counted in `behalten`). Owner-only, IRREVERSIBLE, requires confirmation.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
countintegeryes
behaltenintegeryes

stays.reset-room-override

writes

Clear a single booking's room-swap override, restoring its originally booked room(s). Fails with room_occupied:<room>:<free room>:<guest> when another guest occupies the booked room in that period; pass allowConflict: true only to double-book deliberately.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
allowConflictbooleanno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.schnelltext

writes

Text snippet for the reply field: invoice link, late check-out, access details. Sends NOTHING; the text goes into the input field. Operations roles only: "zugang" (access) carries codes (viewing is logged). Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
artenumyesOne of: rechnung, spaet_checkout, zugang, rechnung_nach_abreise

Output fields

FieldTypeRequiredNotes
textstringyes
spracheenumyesOne of: de, en

stays.set-room-override

writes

Manually swap a booking's room (guest wish, maintenance issue, …). fromRoom must be one of the booking's current effective rooms; toRoom must exist and be free for the stay's dates (considering other bookings' own overrides) unless allowConflict is set — then the room is DELIBERATELY double-occupied. fromRoom === toRoom clears that mapping.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
fromRoomstringyes
toRoomstringyes
reasonstringno
allowConflictbooleanno

Output fields

FieldTypeRequiredNotes
roomMapobjectyes

stays.stornoVorschlag

read-only

What would the guest get back if the booking is cancelled NOW? With a snapshot (`stays.buchungsbedingungen`): tiered by the terms that applied at booking time, accommodation tax refunded in full. Without a snapshot: the old deadline rule, exactly as `cancelAndRefund` applies it. Read-only; the suggestion moves no money, it pre-fills the amount in the cancellation dialog.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
stayIdstringyes
statusstringyes
hatSchnappschussbooleanyes
hatZahlungbooleanyes
bezahltCentsintegeryes
vorschlagCentsintegeryes
prozentintegeryes
grundstringyes
stufeobject · nullableyes
stufe.tageVorAnreiseintegeryes
stufe.erstattungProzentintegeryes
kulanzBisstring · nullableyes
fristenarray of objectyes
fristen.tageVorAnreiseintegeryes
fristen.erstattungProzentintegeryes
fristen.bisstringyes
steuerCentsintegeryes
logisCentsintegeryes
bedingungenobject · nullableyes
bedingungen.regelobjectyes
bedingungen.zahlungstringyes
bedingungen.ratePlanIdstring · nullableyes
bedingungen.ratePlanNamestring · nullableyes
bedingungen.ausAltfeldernbooleanyes
bedingungen.gebuchtAmstringyes
bedingungen.zeitzonestringyes
bedingungen.checkInMinuteintegeryes
fristStundeninteger · nullableyes
darfErstattenbooleanyes

stays.today

read-only

List stays that are arriving, departing, or in-house today.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
arrivalsarray of objectyes
arrivals.idstringyes
arrivals.checkInstring · nullableyes
arrivals.checkOutstring · nullableyes
arrivals.roomstring · nullableyes
arrivals.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
arrivals.expectedArrivalAtstring · nullableyes
arrivals.expectedArrivalQuellestring · nullableyes
arrivals.expectedDepartureAtstring · nullableyes
arrivals.guestNamestring · nullableyes
arrivals.exConversationIdstring · nullableyes
arrivals.externalRefstring · nullableyes
arrivals.hasPortalSessionbooleanyes
arrivals.hasMeldescheinbooleanyes
arrivals.hasSignedbooleanyes
arrivals.hasDepositbooleanyes
arrivals.hasIdUploadbooleanyes
arrivals.ausweisPflichtenumyesOne of: ja, nein, offen
arrivals.gaesteCodeZustandstring · nullableyes
arrivals.ersteOeffnungstring · nullableyes
departuresarray of objectyes
departures.idstringyes
departures.checkInstring · nullableyes
departures.checkOutstring · nullableyes
departures.roomstring · nullableyes
departures.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
departures.expectedArrivalAtstring · nullableyes
departures.expectedArrivalQuellestring · nullableyes
departures.expectedDepartureAtstring · nullableyes
departures.guestNamestring · nullableyes
departures.exConversationIdstring · nullableyes
departures.externalRefstring · nullableyes
departures.hasPortalSessionbooleanyes
departures.hasMeldescheinbooleanyes
departures.hasSignedbooleanyes
departures.hasDepositbooleanyes
departures.hasIdUploadbooleanyes
departures.ausweisPflichtenumyesOne of: ja, nein, offen
departures.gaesteCodeZustandstring · nullableyes
departures.ersteOeffnungstring · nullableyes
inHousearray of objectyes
inHouse.idstringyes
inHouse.checkInstring · nullableyes
inHouse.checkOutstring · nullableyes
inHouse.roomstring · nullableyes
inHouse.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
inHouse.expectedArrivalAtstring · nullableyes
inHouse.expectedArrivalQuellestring · nullableyes
inHouse.expectedDepartureAtstring · nullableyes
inHouse.guestNamestring · nullableyes
inHouse.exConversationIdstring · nullableyes
inHouse.externalRefstring · nullableyes
inHouse.hasPortalSessionbooleanyes
inHouse.hasMeldescheinbooleanyes
inHouse.hasSignedbooleanyes
inHouse.hasDepositbooleanyes
inHouse.hasIdUploadbooleanyes
inHouse.ausweisPflichtenumyesOne of: ja, nein, offen
inHouse.gaesteCodeZustandstring · nullableyes
inHouse.ersteOeffnungstring · nullableyes
kautionNoetigbooleanyes

stays.update_dates

writesconfirm

Move or extend a booking (new check-in/out dates, optionally a different unit). Only manual/direct bookings without an OTA reservation id are editable — OTA reservations are owned by the channel and rejected. A CANCELLED stay keeps its dates (stay_cancelled_price_dates_locked). Requires confirmation.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
checkinDatestringyes
checkoutDatestringyes
roomstringno

Output fields

FieldTypeRequiredNotes
stayIdstringyes

stays.upsellAngebote

read-only

Active extras (late check-out, early/late check-in …) with their status for this stay: status, paid at, and for open ones where the link stands (sent / in a draft / started in the guest portal). Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
offerIdstringyes
typestringyes
labelstringyes
priceCentsintegeryes
betragCentsintegeryes
currencystringyes
statusstring · nullableyes
bezahltAmstring · nullableyes
angebotenAmstring · nullableyes
verschicktAmstring · nullableyes
entwurfAmstring · nullableyes
portalAmstring · nullableyes

stays.upsellVorOrtBezahlt

writesconfirm

Marks an open extra of a stay as paid on site: status paid, the same effect as an online payment (arrival/departure shifted), and service line + payment in the folio. Payment method card (terminal) or cash — cash only with the cash-register function. A still-open Stripe link is closed first; if the guest already paid online, nothing is booked. A second call books nothing twice (`neu: false`). Operator roles. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
offerIdstringyes
zahlartenumyesOne of: card, cash
erwartetCentsintegeryes

Output fields

FieldTypeRequiredNotes
neubooleanyes
betragCentsintegeryes
writes

Payment link for an extra. Sends NOTHING: the link and text go into the reply field. It is booked only after payment (Connect webhook). Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
offerIdstringyes

Output fields

FieldTypeRequiredNotes
urlstringyes
textstringyes

stays.whatsappKonto

writes

Manually set ✓ "hat WhatsApp" (has WhatsApp) / ✗ "kein WhatsApp" (no WhatsApp) / back to open: on opening the WhatsApp link, the operator saw whether the number is registered. Applies to the guest's NUMBER until changed; ✗ holds back the WhatsApp templates, ✓ lifts a ✗. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
statusenumyesOne of: hat, kein, offen

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

stays.zurBuchungsnummer

read-only

The stay for a Booking.com booking number — for the one-click button that hands the phone number from the extranet to Foyer. Guest, room, arrival and the current number for confirmation; `null` = no Booking.com booking with this number. Operations roles only. Read-only query.

Input parameters

FieldTypeRequiredNotes
buchungsnummerstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
stayIdstringyes
hrefstringyes
roomstring · nullableyes
checkInstring · nullableyes
gaststring · nullableyes
telefonstring · nullableyes
storniertbooleanyes