FoyerDevelopers

Generated · Live registry

rates tools

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

All tool domains

rates.blockRoomDates

writes

Block a (room, date) range. Idempotent per (tenant, room, date) unique key. One row per night via ON CONFLICT DO NOTHING. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
roomIdstringyes
fromstringyes
tostringyes
reasonstringno

Output fields

FieldTypeRequiredNotes
countintegeryes

rates.block_dates

writesconfirm

Block a date range for a unit (room id) so it cannot be booked — e.g. maintenance or owner use. Inserts the blocked nights (idempotent) and best-effort closes the dates on connected OTA channels. Dates are YYYY-MM-DD inclusive. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
roomIdstringyes
fromstringyes
tostringyes
reasonstringno

Output fields

FieldTypeRequiredNotes
countnumberyes

rates.bulk_set

writes

Set the same price across a date range for a given room type. Inserts or updates one row per night between dateFrom and dateTo (inclusive). Uses the tenant's default rate plan when ratePlanId is omitted. Returns the count of rows inserted/updated.

Input parameters

FieldTypeRequiredNotes
ratePlanIdstringno
roomTypestringyes
dateFromstringyesFirst night of the range, inclusive.
dateTostringyesLast night of the range, inclusive.
priceCentsintegeryes
currencystringnoDefault: "EUR"

Output fields

FieldTypeRequiredNotes
countintegeryes

rates.createPlan

writes

Create a new rate plan. The name is auto-translated for the booking page; optional namenUebersetzt {de?, en?} sets a language by hand.

Input parameters

FieldTypeRequiredNotes
namestringyes
refundablebooleannoDefault: true
paymentModeenumnoOne of: stripe, pay_at_hotel — Default: "stripe"
minLeadTimeHoursintegerno
guestSegmentenumnoOne of: public, business, package
namenUebersetztobjectno
namenUebersetzt.destringno
namenUebersetzt.enstringno

Output fields

FieldTypeRequiredNotes
idstringyes
namestringyes
isDefaultbooleanyes
priorityintegeryes
refundablebooleanyes
paymentModestringyes
cancellationWindowHoursintegeryes
minLeadTimeHoursinteger · nullableyes
maxLeadTimeDaysinteger · nullableyes
guestSegmentstring · nullableyes
inheritFromIdstring · nullableyes
namenUebersetztobjectyes
tenantIdstringyes
createdAtstringyes

rates.delete

writes

Delete a specific room rate by its UUID. Returns the deleted rate's id.

Input parameters

FieldTypeRequiredNotes
idstringyesUUID of the room_rate row to delete.

Output fields

FieldTypeRequiredNotes
deletedIdstringyes

rates.deletePlan

writesconfirm

Delete an existing rate plan.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

rates.deleteRestriction

writesconfirm

Delete a stay-length/date rate restriction.

Input parameters

FieldTypeRequiredNotes
idsarray of stringyes

Output fields

FieldTypeRequiredNotes
countintegeryes

rates.list

read-only

List room rates for a date range. Optional filters: roomType and ratePlanId (defaults to the tenant's default rate plan if omitted). Returns one row per (roomType, date) with priceCents and currency.

Input parameters

FieldTypeRequiredNotes
fromstringyesStart date inclusive, YYYY-MM-DD.
tostringyesEnd date inclusive, YYYY-MM-DD.
roomTypestringnoFilter to a specific room type.
ratePlanIdstringnoFilter to a specific rate plan.

Output fields

FieldTypeRequiredNotes
ratesarray of objectyes
rates.idstringyes
rates.ratePlanIdstringyes
rates.roomTypestringyes
rates.datestringyes
rates.priceCentsintegeryes
rates.currencystringyes

rates.listBlockedDates

read-only

List operator-managed blocked-date entries in a window. Joined with the room scope so the UI can show per-room blocks (e.g. "DZ-12 on 2026-06-14: Renovierung"). Read-only query.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
roomIdstringyes
datestringyes
reasonstring · nullableyes

rates.listBulkEdits

read-only

Audit-log of bulk-edits (rates + restrictions). Read-only; rows are written by bulkSet.

Input parameters

FieldTypeRequiredNotes
limitintegernoDefault: 50

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
userIdstring · nullableyes
entityKindstringyes
summarystringyes
affectedCountintegeryes
createdAtstringyes
revertedAtstring · nullableyes
revertedBystring · nullableyes
actorLabelstring · nullableyes

rates.listChannelSync

read-only

outbound channel-sync log for the operator's audit surface. Read-only; entries are written by the channel-sync workers (the former hospitable.rate-sync rows stay as history).

Input parameters

FieldTypeRequiredNotes
channelenumnoOne of: hospitable, booking_com_native
succeededOnlybooleannoDefault: false
failedOnlybooleannoDefault: false
limitintegernoDefault: 100

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
channelstringyes
operationstringyes
roomTypestring · nullableyes
dateFromstring · nullableyes
dateTostring · nullableyes
httpStatusinteger · nullableyes
errorMessagestring · nullableyes
succeededbooleanyes
durationMsinteger · nullableyes
createdAtstringyes

rates.listPlans

read-only

List the property's rate plans.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
namestringyes
isDefaultbooleanyes
priorityintegeryes
refundablebooleanyes
paymentModestringyes
cancellationWindowHoursintegeryes
minLeadTimeHoursinteger · nullableyes
maxLeadTimeDaysinteger · nullableyes
guestSegmentstring · nullableyes
inheritFromIdstring · nullableyes
namenUebersetztobjectyes

rates.list_restrictions

read-only

List min-stay / max-stay restrictions for a date range. Optional ratePlanId filter (defaults to tenant's default plan). Returns one row per (roomType, date) with stopSell, cta, ctd, minStay, maxStay flags.

Input parameters

FieldTypeRequiredNotes
fromstringyesStart date inclusive, YYYY-MM-DD.
tostringyesEnd date inclusive, YYYY-MM-DD.
ratePlanIdstringno
roomTypestringno

Output fields

FieldTypeRequiredNotes
restrictionsarray of objectyes
restrictions.idstringyes
restrictions.ratePlanIdstringyes
restrictions.roomTypestringyes
restrictions.datestringyes
restrictions.stopSellbooleanyes
restrictions.ctabooleanyes
restrictions.ctdbooleanyes
restrictions.minStayinteger · nullableyes
restrictions.maxStayinteger · nullableyes

rates.manualResync

writes

manual resync — re-emits the OTA channel rate-sync job for the given range without changing prices. Recovery from a failed channel-sync run. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
roomTypestringyes
fromstringyes
tostringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

rates.pushPrice

writes

Makes the price set in the calendar effective for THIS ONE ROOM. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
roomstringyes
fromstringyes
tostringyes
priceCentsintegeryes

Output fields

FieldTypeRequiredNotes
geschriebenintegeryes
beds24booleanyes

rates.richtwertSetzen

writesconfirm

Set nightly prices from the DOUBLE-ROOM price per day: pass `tage` as [{ datum: 'YYYY-MM-DD', doppelzimmerCents }]. Single, triple and shared-bath room types are derived by the property's pricing rule (Einstellungen → Preisstrategie); rooms with their own price row are set room-exact. Every price is pushed to Beds24 (Booking.com/Airbnb) immediately, logged and undoable like the rate calendar. Changes live selling prices — requires confirmation.

Input parameters

FieldTypeRequiredNotes
tagearray of objectyes
tage.datumstringyes
tage.doppelzimmerCentsintegeryes

Output fields

FieldTypeRequiredNotes
gesetztarray of objectyes
gesetzt.datumstringyes
gesetzt.zielstringyes
gesetzt.centsintegeryes

rates.unblockDates

writes

Unblock by id. Returns count of removed rows. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idsarray of stringyes

Output fields

FieldTypeRequiredNotes
countintegeryes

rates.undoBulkEdit

writes

undo a bulk-edit by restoring old prices from diffJson. New rows (oldPriceCents === null) are deleted; existing rows have their price restored. Marks the audit row with revertedAt. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
countintegeryes

rates.unit-calendar

read-only

Per-unit nightly PRICES for a date window, from Foyer's own price per room (`room_rates`). Returns room (unit code), date, priceCents, currency, minNights, and beds24PriceCents (only when Beds24 sells a different price — price floor per room type / 650 EUR cap). At most 400 nights per window. Says NOTHING about whether a night is free — bookings and blocks are not considered; use `availability.query` for that. Read-only.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

FieldTypeRequiredNotes
daysarray of objectyes
days.roomstringyes
days.datestringyes
days.priceCentsinteger · nullableyes
days.currencystring · nullableyes
days.minNightsinteger · nullableyes
days.beds24PriceCentsintegerno

rates.updatePlan

writes

Edit an existing rate plan. Renaming re-translates the booking-page name; calling with just id fills missing languages. namenUebersetzt {"en": "..."} sets the English guest-facing name by hand, {"en": ""} returns it to automatic.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringno
refundablebooleanno
paymentModeenumnoOne of: stripe, pay_at_hotel
minLeadTimeHoursinteger · nullableno
guestSegmentenum · nullablenoOne of: public, business, package
namenUebersetztobjectno
namenUebersetzt.destringno
namenUebersetzt.enstringno

Output fields

FieldTypeRequiredNotes
idstringyes
namestringyes
isDefaultbooleanyes
priorityintegeryes
refundablebooleanyes
paymentModestringyes
cancellationWindowHoursintegeryes
minLeadTimeHoursinteger · nullableyes
maxLeadTimeDaysinteger · nullableyes
guestSegmentstring · nullableyes
inheritFromIdstring · nullableyes
namenUebersetztobjectyes
tenantIdstringyes
createdAtstringyes

rates.upsert

writes

Set the price for a specific room type on a specific date. Creates the row if it does not exist, or updates priceCents and currency if it does. Uses the tenant's default rate plan when ratePlanId is omitted.

Input parameters

FieldTypeRequiredNotes
ratePlanIdstringno
roomTypestringyes
datestringyes
priceCentsintegeryes
currencystringnoDefault: "EUR"

Output fields

FieldTypeRequiredNotes
idstringyes
ratePlanIdstringyes
roomTypestringyes
datestringyes
priceCentsintegeryes
currencystringyes

rates.upsertRestriction

writes

Sets or replaces a day's restrictions for a room type (roomType, date): stopSell, closed to arrival and closed to departure (cta, ctd), minStay and maxStay; if ratePlanId is omitted, the default rate plan applies. Triggers the sync with the connected channels. Owner only. Changes data; a minStay greater than maxStay is rejected. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
ratePlanIdstringno
roomTypestringyes
datestringyes
stopSellbooleannoDefault: false
ctabooleannoDefault: false
ctdbooleannoDefault: false
minStayintegerno
maxStayintegerno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
ratePlanIdstringyes
roomTypestringyes
datestringyes
stopSellbooleanyes
ctabooleanyes
ctdbooleanyes
minStayinteger · nullableyes
maxStayinteger · nullableyes
createdAtstringyes
updatedAtstringyes