stays.aenderungen
The change history of ONE booking: who touched which field and when. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
limit | integer | no | Default: 50 |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
action | string | yes | |
createdAt | string | yes | |
akteur | string · nullable | yes | |
aenderungen | array of object | yes | |
aenderungen.feld | string | yes | |
aenderungen.vorher | string · nullable | yes | |
aenderungen.nachher | string · nullable | yes | |
folio | object · nullable | yes | |
folio.zeilen | number | yes | |
folio.summeCents | number | yes | |
herkunft | string · nullable | yes |
stays.anfrageZimmer
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
zimmer | string | yes | |
kategorie | string · nullable | yes | |
checkIn | string | yes | |
checkOut | string | yes | |
belegteNaechte | array of string | yes | |
frei | array of object | yes | |
frei.zimmerId | string | yes | |
frei.name | string | yes | |
frei.gleicherPreis | boolean | yes | |
preisCents | number · nullable | yes | |
kanalBetragCents | number · nullable | yes | |
gebuehrSatz | number · nullable | yes | |
waehrung | string | yes | |
vorname | string · nullable | yes | |
plattform | string · nullable | yes |
stays.anreisenOhneTelefon
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
| Field | Type | Required | Notes |
|---|---|---|---|
hotelIdFehlt | boolean | yes | |
anreisen | array of object | yes | |
anreisen.stayId | string | yes | |
anreisen.href | string | yes | |
anreisen.room | string · nullable | yes | |
anreisen.checkIn | string · nullable | yes | |
anreisen.gast | string · nullable | yes | |
anreisen.buchungsnummer | string · nullable | yes | |
anreisen.extranetLink | string · nullable | yes |
stays.aufEinenBlick
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
saetze | array of object | yes | |
saetze.schluessel | string | yes | |
saetze.werte | object | yes | |
saetze.roh | object | no | |
chips | array of object | yes | |
chips.art | enum | yes | One of: bezahlt, vor_ort, ankunft, angekommen, checkin_ab |
chips.wert | string · nullable | yes | |
chips.ton | enum | yes | One of: gruen, neutral, hinweis |
chips.roh | object | no | |
bezahltDetail | object · nullable | yes | |
bezahltDetail.schluessel | string | yes | |
bezahltDetail.werte | object | yes | |
bezahltDetail.roh | object | no | |
punkte | array of object | yes | |
punkte.art | enum | yes | One of: anliegen, online_checkin, vorfall, fehlgeschlagen |
punkte.titel | object | yes | |
punkte.unterzeile | object · nullable | yes | |
punkte.ziel | string · nullable | yes | |
punkte.kuemmertSich | object · nullable | no | |
punkte.queueId | string | no | |
widerspruch | object · nullable | yes | |
widerspruch.text | object | yes | |
widerspruch.ziel | string | yes | |
widerspruch.messageId | string | yes | |
kurz | array of object | yes | |
kurz.schluessel | string | yes | |
kurz.werte | object | yes | |
kurz.roh | object | no | |
stationen | array of object | yes | |
stationen.id | string | yes | |
stationen.art | enum | yes | One of: buchung, extra, online_checkin, zugang, anreise, abreise, storno |
stationen.zeit | string | yes | |
stationen.status | enum | yes | One of: fertig, problem, jetzt, geplant |
stationen.ziel | string · nullable | yes | |
stationen.detail | object · nullable | yes | |
stationen.hinweis | object · nullable | yes | |
anliegenMarker | array of object | yes | |
anliegenMarker.zeit | string | yes | |
anliegenMarker.titel | string | yes | |
anliegenMarker.ziel | string · nullable | yes | |
jetzt | string | yes | |
angekommenAm | string · nullable | yes | |
phase | enum | yes | One of: anfrage, vor_anreise, im_haus, abgereist, storniert |
nachrichten | array of object | yes | |
nachrichten.id | string | yes | |
nachrichten.titel | string | yes | |
nachrichten.zeit | string | yes | |
nachrichten.status | enum | yes | One of: gesendet, geplant, ausgelassen, fehlgeschlagen |
nachrichten.ziel | string · nullable | yes | |
ziel | object · nullable | yes | |
ziel.stationen | array of object | yes | |
ziel.erreicht | boolean | yes | |
ziel.jetztNach | enum · nullable | yes | One of: buchung, bestaetigung, portal, code, eingecheckt |
ziel.codeUebergeben | object · nullable | yes | |
ziel.portalStand | object · nullable | yes | |
aufenthalt | object · nullable | yes | |
aufenthalt.naechte | array of object | yes | |
aufenthalt.checkout | object | yes | |
aufenthalt.heuteNacht | integer · nullable | yes | |
aufenthalt.zimmer | array of object | yes |
stays.booking-panel
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
reservation | object | yes | |
reservation.code | string · nullable | yes | |
reservation.platform | string · nullable | yes | |
reservation.status | string | yes | |
reservation.otaStatus | string · nullable | yes | |
reservation.room | string · nullable | yes | |
reservation.roomName | string · nullable | yes | |
reservation.checkIn | string · nullable | yes | |
reservation.checkOut | string · nullable | yes | |
reservation.expectedArrivalAt | string · nullable | yes | |
reservation.expectedArrivalQuelle | string · nullable | no | |
reservation.nights | number · nullable | yes | |
reservation.guestsCount | number · nullable | yes | |
reservation.adults | number · nullable | yes | |
reservation.children | number · nullable | yes | |
reservation.infants | number · nullable | yes | |
reservation.pets | number · nullable | yes | |
reservation.totalFormatted | string · nullable | yes | |
reservation.exConversationId | string · nullable | yes | |
reservation.externalRef | string · nullable | yes | |
guest | object | yes | |
guest.name | string · nullable | yes | |
guest.email | string · nullable | yes | |
guest.phone | string · nullable | yes | |
guest.locale | string · nullable | yes | |
guest.location | string · nullable | yes | |
guest.sameDayBooking | boolean | yes | |
guest.bookingDate | string · nullable | yes | |
property | object · nullable | yes | |
property.addressDisplay | string · nullable | yes | |
property.wifiName | string · nullable | yes | |
property.wifiPassword | string · nullable | yes | |
property.maxGuests | number · nullable | yes | |
property.petsAllowed | boolean · nullable | yes | |
property.smokingAllowed | boolean · nullable | yes | |
property.eventsAllowed | boolean · nullable | yes | |
financials | object | yes | |
financials.currency | string | yes | |
financials.host | array of object | yes | |
financials.guest | array of object | yes | |
financials.kanalHinweis | object · nullable | yes | |
financials.vorOrt | object · nullable | no | |
activity | array of object | yes | |
activity.ruleName | string · nullable | yes | |
activity.status | string | yes | |
activity.at | string · nullable | yes | |
tasks | array of object | yes | |
tasks.id | string | yes | |
tasks.kind | string | yes | |
tasks.status | string | yes | |
tasks.scheduledFor | string · nullable | yes | |
tasks.title | string · nullable | yes | |
tasks.quelle | enum | yes | One of: reinigung, aufgabe |
stays.byId
Get full detail for a single stay/reservation by id.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
guestId | string | yes | |
externalRef | string · nullable | yes | |
externalCode | string · nullable | yes | |
sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice, channex, beds24 |
checkIn | string · nullable | yes | |
checkOut | string · nullable | yes | |
room | string · nullable | yes | |
status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
otaStatus | string · nullable | yes | |
bookingDate | string · nullable | yes | |
issueAlert | string · nullable | yes | |
stayType | string · nullable | yes | |
notes | string · nullable | yes | |
createdAt | string | yes | |
paymentIntentId | string · nullable | yes | |
paymentStatus | string · nullable | yes | |
bookingTotalCents | integer · nullable | yes | |
currencyCode | string · nullable | yes | |
expectedArrivalAt | string · nullable | yes | |
folioClosed | string · nullable | yes | |
holdExpiresAt | string · nullable | yes | |
source | string · nullable | yes | |
guestsCount | integer · nullable | yes | |
adults | integer · nullable | yes | |
children | integer · nullable | yes | |
infants | integer · nullable | yes | |
pets | integer · nullable | yes | |
nights | integer · nullable | yes | |
otaSource | string · nullable | yes | |
otaReservationId | string · nullable | yes | |
guestName | string · nullable | yes | |
bookingStays | array of object | yes | |
bookingStays.id | string | yes | |
bookingStays.room | string · nullable | yes | |
bookingRooms | array of string | yes | |
chatStayId | string | yes | |
exConversationId | string · nullable | yes |
stays.cancel_and_refund
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
forceRefund | boolean | no | Default: false |
erstattungCents | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
refunded | boolean | yes | |
refundId | string · nullable | yes | |
windowHours | number | yes | |
eligibleByPolicy | boolean | yes | |
erstattungCents | integer | yes | |
vorschlagCents | integer · nullable | yes | |
grund | string | yes | |
hatSchnappschuss | boolean | yes |
stays.cardDetail
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
room | string · nullable | yes | |
status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
otaStatus | string · nullable | yes | |
source | string · nullable | yes | |
plattformEtikett | string · nullable | yes | |
sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice, channex, beds24 |
externalCode | string · nullable | yes | |
externalRef | string · nullable | yes | |
otaSource | string · nullable | yes | |
otaReservationId | string · nullable | yes | |
lokalerVorrangAm | string · nullable | yes | |
kanalAbgleichStand | string · nullable | yes | |
kanalAbgleichFehler | string · nullable | yes | |
checkIn | string · nullable | yes | |
checkOut | string · nullable | yes | |
expectedArrivalAt | string · nullable | yes | |
nights | integer · nullable | yes | |
bookingTotalCents | integer · nullable | yes | |
currencyCode | string · nullable | yes | |
adults | integer · nullable | yes | |
children | integer · nullable | yes | |
infants | integer · nullable | yes | |
pets | integer · nullable | yes | |
guestsCount | integer · nullable | yes | |
paymentStatus | string · nullable | yes | |
guestId | string | yes | |
guestName | string · nullable | yes | |
guestEmail | string · nullable | yes | |
guestPhone | string · nullable | yes | |
locale | string · nullable | yes | |
exConversationId | string · nullable | yes | |
bookingRooms | array of string | yes |
stays.checkoutZuruecknehmbar
Can an automatic check-out (departure message, announced early departure, accepted suggestion) be undone? Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
zuruecknehmbar | boolean | yes |
stays.checkoutZuruecknehmen
“Check back in”: undoes an automatic check-out. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.codeUebergeben
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes | |
codeUebergebenAm | string | yes |
stays.createWalkIn
Create a walk-in booking directly (no OTA) — for a guest arriving without a prior reservation.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
guestName | string | yes | |
guestEmail | string | no | |
guestPhone | string | no | |
room | string | no | |
checkinDate | string | yes | |
checkoutDate | string | yes | |
notes | string | no | |
totalCents | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
stays.create_booking
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
| Field | Type | Required | Notes |
|---|---|---|---|
guestName | string | yes | |
guestEmail | string | no | |
guestPhone | string | no | |
room | string | no | |
checkinDate | string | yes | |
checkoutDate | string | yes | |
status | enum | no | One of: confirmed, pending, checked_in — Default: "confirmed" |
source | enum | no | One of: direct, booking, airbnb, manual — Default: "manual" |
totalCents | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
stays.forWindow
List stays overlapping a given date window, for calendar/occupancy-style views.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
from | string | yes | |
to | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
checkIn | string · nullable | yes | |
checkOut | string · nullable | yes | |
room | string · nullable | yes | |
status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
otaStatus | string · nullable | yes | |
bookingDate | string · nullable | yes | |
createdAt | string | yes | |
sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice, channex, beds24 |
source | string · nullable | yes | |
plattformEtikett | string · nullable | yes | |
guestName | string · nullable | yes | |
otaReservationId | string · nullable | yes | |
otaSource | string · nullable | yes | |
exConversationId | string · nullable | yes | |
externalRef | string · nullable | yes | |
rooms | array of string | yes | |
hasRoomOverride | boolean | yes | |
originalRooms | array of string | yes |
stays.gastAngabeSetzen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
land | string · nullable | no | |
sprache | string · nullable | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.gastAuswertungWiderspruch
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
aufheben | boolean | no | Default: false |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
geloescht | integer | yes |
stays.gastEmailUebernehmen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
messageId | string | yes | |
email | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
email | string | yes | |
geaendert | boolean | yes |
stays.gastInfo
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
land | string · nullable | yes | |
landQuelle | enum · nullable | yes | One of: hand, meldeschein, buchung, vorwahl |
sprache | string · nullable | yes | |
spracheQuelle | enum · nullable | yes | One of: hand, buchung, nachrichten, vorwahl |
waNummer | string · nullable | yes | |
waKonto | object · nullable | yes | |
waKonto.status | enum | yes | One of: hat, kein |
waKonto.quelle | enum | yes | One of: meta, betreiber |
waKonto.bis | string · nullable | yes | |
notiz | object · nullable | yes | |
notiz.text | string | yes | |
notiz.aktualisiertAm | string · nullable | yes | |
hatteProbleme | boolean | yes | |
probleme | array of string | yes | |
problemVomGastErledigtAm | string · nullable | yes | |
problemErledigt | object · nullable | yes | |
problemErledigt.am | string | yes | |
problemErledigt.quelle | enum | yes | One of: gast, ki, manuell |
problemErledigt.von | string · nullable | yes | |
ankunftLautGast | string · nullable | yes | |
buchung | object · nullable | yes | |
buchung.land | string · nullable | yes | |
buchung.ort | string · nullable | yes | |
buchung.firma | string · nullable | yes | |
buchung.ankunft | object · nullable | yes | |
buchung.vorausbezahlt | boolean | yes | |
buchung.hinweise | array of string | yes | |
firmaLautNachricht | string · nullable | yes | |
auswertungWiderspruchAm | string · nullable | yes | |
telefonVonBookingVorenthalten | boolean | yes | |
portalHaengt | object · nullable | yes |
stays.gastKontaktSetzen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
art | enum | yes | One of: email, telefon |
wert | string | yes | |
quelle | enum | no | One of: faden, extranet — Default: "faden" |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
wert | string | yes | |
geaendert | boolean | yes | |
gesichert | boolean | yes |
stays.gastNotizSetzen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
notiz | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.gastTelefonUebernehmen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
messageId | string | yes | |
nummer | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
nummer | string | yes | |
geaendert | boolean | yes | |
ersetzt | boolean | yes |
stays.get
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
stay | object · nullable | yes | |
stay.id | string | yes | |
stay.guestId | string | yes | |
stay.externalRef | string · nullable | yes | |
stay.sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice |
stay.checkIn | string · nullable | yes | |
stay.checkOut | string · nullable | yes | |
stay.room | string · nullable | yes | |
stay.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
guest | object · nullable | yes | |
guest.id | string | yes | |
guest.canonicalEmail | string · nullable | yes | |
guest.canonicalPhone | string · nullable | yes | |
guest.nameHint | string · nullable | yes | |
guest.locale | string · nullable | yes | |
conversation | object · nullable | yes | |
conversation.id | string | yes | |
conversation.openedAt | string | yes | |
conversation.lastMessageAt | string · nullable | yes | |
conversation.messageCount | integer | yes |
stays.list
List stays/reservations, optionally filtered (date range, guest, status).
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
filter | enum | no | One of: today, upcoming, past, all, voice-holds — Default: "all" |
limit | integer | no | Default: 50 |
offset | integer | no | Default: 0 |
guestId | string | no | |
search | string | no |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
checkIn | string · nullable | yes | |
checkOut | string · nullable | yes | |
room | string · nullable | yes | |
status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice, channex, beds24 |
guestName | string · nullable | yes | |
guestEmail | string · nullable | yes | |
guestPhone | string · nullable | yes | |
otaSource | string · nullable | yes | |
otaReservationId | string · nullable | yes | |
exConversationId | string · nullable | yes | |
externalRef | string · nullable | yes | |
rooms | array of string | yes | |
roomCount | integer | yes |
stays.list_active
List stays whose check_out is today or later. Includes pending and confirmed. Read-only.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.guestId | string | yes | |
items.externalRef | string · nullable | yes | |
items.sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice |
items.checkIn | string · nullable | yes | |
items.checkOut | string · nullable | yes | |
items.room | string · nullable | yes | |
items.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
stays.list_for_guest
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
| Field | Type | Required | Notes |
|---|---|---|---|
guestId | string | yes | |
excludeStayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.guestId | string | yes | |
items.externalRef | string · nullable | yes | |
items.sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice |
items.checkIn | string · nullable | yes | |
items.checkOut | string · nullable | yes | |
items.room | string · nullable | yes | |
items.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
stays.perform_checkout
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.prior_stays
List a guest's prior stays, newest-first. Optionally exclude a stayId (the current one). Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
guestId | string | yes | |
excludeStayId | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.guestId | string | yes | |
items.externalRef | string · nullable | yes | |
items.sourceChannel | enum · nullable | yes | One of: whatsapp, email, hospitable, voice |
items.checkIn | string · nullable | yes | |
items.checkOut | string · nullable | yes | |
items.room | string · nullable | yes | |
items.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
stays.problemErledigt
"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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
geaendert | boolean | yes |
stays.problemWiederOeffnen
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
aufgehoben | integer | yes |
stays.protokoll
The log across ALL bookings: the audit view. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
limit | integer | no | Default: 100 |
vor | string | no |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
action | string | yes | |
createdAt | string | yes | |
akteur | string · nullable | yes | |
stayId | string · nullable | yes | |
gast | string · nullable | yes | |
zimmer | string · nullable | yes | |
anzahlAenderungen | number | yes |
stays.rechnungsFortschritt
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
anfrageId | string · nullable | yes | |
messageId | string · nullable | yes | |
stationen | array of object | yes | |
stationen.art | enum | yes | One of: angefragt, formular, ausgefuellt, erstellt, versendet |
stationen.status | enum | yes | One of: fertig, naechste, offen, abgelehnt |
stationen.zeit | string · nullable | yes | |
formularMessageId | string · nullable | yes | |
formularLink | string · nullable | yes | |
rechnung | object · nullable | yes | |
rechnung.id | string | yes | |
rechnung.nummer | string · nullable | yes | |
rechnung.url | string · nullable | yes | |
rechnungVorAbgabe | object · nullable | no | |
rechnungVorAbgabe.id | string | yes | |
rechnungVorAbgabe.nummer | string · nullable | yes | |
rechnungVorAbgabe.url | string · nullable | yes | |
treffer | string · nullable | yes |
stays.rechnungsVerlauf
History of the invoice request for the left panel. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
zeit | string | yes | |
art | enum | yes | One of: perk_anfrage, perk_nachfrage, daten_eingegangen, status, ausgestellt, versand_geplant, versendet, gestoppt |
text | string · nullable | yes | |
inhalt | string | no |
stays.reset-all-room-overrides
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
| Field | Type | Required | Notes |
|---|---|---|---|
count | integer | yes | |
behalten | integer | yes |
stays.reset-room-override
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
allowConflict | boolean | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.schnelltext
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
art | enum | yes | One of: rechnung, spaet_checkout, zugang, rechnung_nach_abreise |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
text | string | yes | |
sprache | enum | yes | One of: de, en |
stays.set-room-override
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
fromRoom | string | yes | |
toRoom | string | yes | |
reason | string | no | |
allowConflict | boolean | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
roomMap | object | yes |
stays.stornoVorschlag
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
status | string | yes | |
hatSchnappschuss | boolean | yes | |
hatZahlung | boolean | yes | |
bezahltCents | integer | yes | |
vorschlagCents | integer | yes | |
prozent | integer | yes | |
grund | string | yes | |
stufe | object · nullable | yes | |
stufe.tageVorAnreise | integer | yes | |
stufe.erstattungProzent | integer | yes | |
kulanzBis | string · nullable | yes | |
fristen | array of object | yes | |
fristen.tageVorAnreise | integer | yes | |
fristen.erstattungProzent | integer | yes | |
fristen.bis | string | yes | |
steuerCents | integer | yes | |
logisCents | integer | yes | |
bedingungen | object · nullable | yes | |
bedingungen.regel | object | yes | |
bedingungen.zahlung | string | yes | |
bedingungen.ratePlanId | string · nullable | yes | |
bedingungen.ratePlanName | string · nullable | yes | |
bedingungen.ausAltfeldern | boolean | yes | |
bedingungen.gebuchtAm | string | yes | |
bedingungen.zeitzone | string | yes | |
bedingungen.checkInMinute | integer | yes | |
fristStunden | integer · nullable | yes | |
darfErstatten | boolean | yes |
stays.today
List stays that are arriving, departing, or in-house today.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
arrivals | array of object | yes | |
arrivals.id | string | yes | |
arrivals.checkIn | string · nullable | yes | |
arrivals.checkOut | string · nullable | yes | |
arrivals.room | string · nullable | yes | |
arrivals.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
arrivals.expectedArrivalAt | string · nullable | yes | |
arrivals.expectedArrivalQuelle | string · nullable | yes | |
arrivals.expectedDepartureAt | string · nullable | yes | |
arrivals.guestName | string · nullable | yes | |
arrivals.exConversationId | string · nullable | yes | |
arrivals.externalRef | string · nullable | yes | |
arrivals.hasPortalSession | boolean | yes | |
arrivals.hasMeldeschein | boolean | yes | |
arrivals.hasSigned | boolean | yes | |
arrivals.hasDeposit | boolean | yes | |
arrivals.hasIdUpload | boolean | yes | |
arrivals.ausweisPflicht | enum | yes | One of: ja, nein, offen |
arrivals.gaesteCodeZustand | string · nullable | yes | |
arrivals.ersteOeffnung | string · nullable | yes | |
departures | array of object | yes | |
departures.id | string | yes | |
departures.checkIn | string · nullable | yes | |
departures.checkOut | string · nullable | yes | |
departures.room | string · nullable | yes | |
departures.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
departures.expectedArrivalAt | string · nullable | yes | |
departures.expectedArrivalQuelle | string · nullable | yes | |
departures.expectedDepartureAt | string · nullable | yes | |
departures.guestName | string · nullable | yes | |
departures.exConversationId | string · nullable | yes | |
departures.externalRef | string · nullable | yes | |
departures.hasPortalSession | boolean | yes | |
departures.hasMeldeschein | boolean | yes | |
departures.hasSigned | boolean | yes | |
departures.hasDeposit | boolean | yes | |
departures.hasIdUpload | boolean | yes | |
departures.ausweisPflicht | enum | yes | One of: ja, nein, offen |
departures.gaesteCodeZustand | string · nullable | yes | |
departures.ersteOeffnung | string · nullable | yes | |
inHouse | array of object | yes | |
inHouse.id | string | yes | |
inHouse.checkIn | string · nullable | yes | |
inHouse.checkOut | string · nullable | yes | |
inHouse.room | string · nullable | yes | |
inHouse.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
inHouse.expectedArrivalAt | string · nullable | yes | |
inHouse.expectedArrivalQuelle | string · nullable | yes | |
inHouse.expectedDepartureAt | string · nullable | yes | |
inHouse.guestName | string · nullable | yes | |
inHouse.exConversationId | string · nullable | yes | |
inHouse.externalRef | string · nullable | yes | |
inHouse.hasPortalSession | boolean | yes | |
inHouse.hasMeldeschein | boolean | yes | |
inHouse.hasSigned | boolean | yes | |
inHouse.hasDeposit | boolean | yes | |
inHouse.hasIdUpload | boolean | yes | |
inHouse.ausweisPflicht | enum | yes | One of: ja, nein, offen |
inHouse.gaesteCodeZustand | string · nullable | yes | |
inHouse.ersteOeffnung | string · nullable | yes | |
kautionNoetig | boolean | yes |
stays.update_dates
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
checkinDate | string | yes | |
checkoutDate | string | yes | |
room | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
stays.upsellAngebote
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
offerId | string | yes | |
type | string | yes | |
label | string | yes | |
priceCents | integer | yes | |
betragCents | integer | yes | |
currency | string | yes | |
status | string · nullable | yes | |
bezahltAm | string · nullable | yes | |
angebotenAm | string · nullable | yes | |
verschicktAm | string · nullable | yes | |
entwurfAm | string · nullable | yes | |
portalAm | string · nullable | yes |
stays.upsellVorOrtBezahlt
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
offerId | string | yes | |
zahlart | enum | yes | One of: card, cash |
erwartetCents | integer | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
neu | boolean | yes | |
betragCents | integer | yes |
stays.upsellZahlungslink
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
offerId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
url | string | yes | |
text | string | yes |
stays.whatsappKonto
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
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
status | enum | yes | One of: hat, kein, offen |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
stays.zurBuchungsnummer
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
| Field | Type | Required | Notes |
|---|---|---|---|
buchungsnummer | string | yes |
Output fields
The whole object may be null.
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes | |
href | string | yes | |
room | string · nullable | yes | |
checkIn | string · nullable | yes | |
gast | string · nullable | yes | |
telefon | string · nullable | yes | |
storniert | boolean | yes |