rates tools · Foyer Connect

`rates.blockRoomDates`

writes

Rates: block room dates. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`roomId`	string	yes
`from`	string	yes
`to`	string	yes
`reason`	string	no

Output fields

Field	Type	Required	Notes
`count`	integer	yes

`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

Field	Type	Required
`roomId`	string	yes
`from`	string	yes
`to`	string	yes
`reason`	string	no

Output fields

Field	Type	Required	Notes
`count`	number	yes

`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

Field	Type	Required	Notes
`ratePlanId`	string	no
`roomType`	string	yes
`dateFrom`	string	yes	First night of the range, inclusive.
`dateTo`	string	yes	Last night of the range, inclusive.
`priceCents`	integer	yes
`currency`	string	no	Default: "EUR"

Output fields

Field	Type	Required	Notes
`count`	integer	yes

`rates.createPlan`

writes

Create a new rate plan.

Input parameters

Field	Type	Required	Notes
`name`	string	yes
`refundable`	boolean	no	Default: true
`paymentMode`	enum	no	One of: stripe, pay_at_hotel — Default: "stripe"
`minLeadTimeHours`	integer	no
`guestSegment`	enum	no	One of: public, business, package

Output fields

Field	Type	Required
`id`	string	yes
`name`	string	yes
`isDefault`	boolean	yes
`priority`	integer	yes
`refundable`	boolean	yes
`paymentMode`	string	yes
`cancellationWindowHours`	integer	yes
`minLeadTimeHours`	integer · nullable	yes
`maxLeadTimeDays`	integer · nullable	yes
`guestSegment`	string · nullable	yes
`inheritFromId`	string · nullable	yes
`tenantId`	string	yes
`createdAt`	string	yes

`rates.delete`

writes

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

Input parameters

Field	Type	Required	Notes
`id`	string	yes	UUID of the room_rate row to delete.

Output fields

Field	Type	Required	Notes
`deletedId`	string	yes

`rates.deletePlan`

writesconfirm

Delete an existing rate plan.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`ok`	literal	yes	One of: true

`rates.deleteRestriction`

writesconfirm

Delete a stay-length/date rate restriction.

Input parameters

Field	Type	Required	Notes
`ids`	array of string	yes

Output fields

Field	Type	Required	Notes
`count`	integer	yes

`rates.dreibettAbstand`

read-only

Rates: dreibett abstand. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Field	Type	Required	Notes
`faelle`	number	yes
`tage`	number	yes
`darunter`	number	yes
`zimmer`	array of string	yes
`mindestabstandCents`	number	yes
`verstoesse`	array of object	yes
`verstoesse.date`	string	yes
`verstoesse.room`	string	yes
`verstoesse.preisCents`	number	yes
`verstoesse.teuerstesDoppel`	string	yes
`verstoesse.doppelCents`	number	yes
`verstoesse.abstandCents`	number	yes
`verstoesse.sollCents`	number	yes
`verstoesse.grund`	enum	yes	One of: faktor, mindestabstand
`verstoesse.fehltCents`	number	yes
`verstoesse.available`	boolean	yes

`rates.freigebenBeiHospitable`

writes

Rates: freigeben bei hospitable. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`room`	string	yes
`from`	string	yes
`to`	string	yes

Output fields

Field	Type	Required
`freigegeben`	integer	yes
`ohnePreis`	integer	yes
`uebersprungen`	integer	yes

`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

Field	Type	Required	Notes
`from`	string	yes	Start date inclusive, YYYY-MM-DD.
`to`	string	yes	End date inclusive, YYYY-MM-DD.
`roomType`	string	no	Filter to a specific room type.
`ratePlanId`	string	no	Filter to a specific rate plan.

Output fields

Field	Type	Required
`rates`	array of object	yes
`rates.id`	string	yes
`rates.ratePlanId`	string	yes
`rates.roomType`	string	yes
`rates.date`	string	yes
`rates.priceCents`	integer	yes
`rates.currency`	string	yes

`rates.listBlockedDates`

read-only

Rates: list blocked dates. Read-only query. See the input schema for argument details.

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
`id`	string	yes
`roomId`	string	yes
`date`	string	yes
`reason`	string · nullable	yes

`rates.listBulkEdits`

read-only

Rates: list bulk edits. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`limit`	integer	no	Default: 50

Output fields

Returns array of object. Fields of each element:

Field	Type	Required
`id`	string	yes
`tenantId`	string	yes
`userId`	string · nullable	yes
`entityKind`	string	yes
`summary`	string	yes
`affectedCount`	integer	yes
`createdAt`	string	yes
`revertedAt`	string · nullable	yes
`revertedBy`	string · nullable	yes
`actorLabel`	string · nullable	yes

`rates.listChannelSync`

read-only

Rates: list channel sync. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`channel`	enum	no	One of: hospitable, booking_com_native
`succeededOnly`	boolean	no	Default: false
`failedOnly`	boolean	no	Default: false
`limit`	integer	no	Default: 100

Output fields

Returns array of object. Fields of each element:

Field	Type	Required
`id`	string	yes
`tenantId`	string	yes
`channel`	string	yes
`operation`	string	yes
`roomType`	string · nullable	yes
`dateFrom`	string · nullable	yes
`dateTo`	string · nullable	yes
`httpStatus`	integer · nullable	yes
`errorMessage`	string · nullable	yes
`succeeded`	boolean	yes
`durationMs`	integer · nullable	yes
`createdAt`	string	yes

`rates.listPlans`

read-only

List the property's rate plans.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

Field	Type	Required
`id`	string	yes
`name`	string	yes
`isDefault`	boolean	yes
`priority`	integer	yes
`refundable`	boolean	yes
`paymentMode`	string	yes
`cancellationWindowHours`	integer	yes
`minLeadTimeHours`	integer · nullable	yes
`maxLeadTimeDays`	integer · nullable	yes
`guestSegment`	string · nullable	yes
`inheritFromId`	string · nullable	yes

`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

Field	Type	Required	Notes
`from`	string	yes	Start date inclusive, YYYY-MM-DD.
`to`	string	yes	End date inclusive, YYYY-MM-DD.
`ratePlanId`	string	no
`roomType`	string	no

Output fields

Field	Type	Required
`restrictions`	array of object	yes
`restrictions.id`	string	yes
`restrictions.ratePlanId`	string	yes
`restrictions.roomType`	string	yes
`restrictions.date`	string	yes
`restrictions.stopSell`	boolean	yes
`restrictions.cta`	boolean	yes
`restrictions.ctd`	boolean	yes
`restrictions.minStay`	integer · nullable	yes
`restrictions.maxStay`	integer · nullable	yes

`rates.manualResync`

writes

Rates: manual resync. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`roomType`	string	yes
`from`	string	yes
`to`	string	yes

Output fields

Field	Type	Required	Notes
`ok`	literal	yes	One of: true

`rates.pushPrice`

writes

Rates: push price. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`room`	string	yes
`from`	string	yes
`to`	string	yes
`priceCents`	integer	yes

Output fields

Field	Type	Required
`geschrieben`	integer	yes
`beds24`	boolean	yes
`hospitable`	object	yes
`hospitable.ok`	boolean	yes
`hospitable.grund`	string · nullable	yes

`rates.syncUnitCalendar`

writes

Rates: sync unit calendar. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`from`	string	yes
`to`	string	yes
`nurWennVeraltet`	boolean	no

Output fields

Field	Type	Required
`properties`	integer	yes
`daysUpserted`	integer	yes
`uebersprungen`	boolean	no

`rates.unblockDates`

writes

Rates: unblock dates. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`ids`	array of string	yes

Output fields

Field	Type	Required	Notes
`count`	integer	yes

`rates.undoBulkEdit`

writes

Rates: undo bulk edit. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`count`	integer	yes

`rates.unit-calendar`

read-only

Per-unit nightly prices + availability mirrored from Hospitable's calendar for a date window. Returns room (unit code), date, priceCents, currency, available. Read-only; populated by the hospitable-calendar-sync worker.

Input parameters

Field	Type	Required	Notes
`from`	string	yes
`to`	string	yes

Output fields

Field	Type	Required
`days`	array of object	yes
`days.room`	string	yes
`days.date`	string	yes
`days.priceCents`	integer · nullable	yes
`days.currency`	string · nullable	yes
`days.available`	boolean	yes
`days.minNights`	integer · nullable	yes

`rates.updatePlan`

writes

Edit an existing rate plan.

Input parameters

Field	Type	Required	Notes
`id`	string	yes
`name`	string	no
`refundable`	boolean	no
`paymentMode`	enum	no	One of: stripe, pay_at_hotel
`minLeadTimeHours`	integer · nullable	no
`guestSegment`	enum · nullable	no	One of: public, business, package

Output fields

Field	Type	Required
`id`	string	yes
`name`	string	yes
`isDefault`	boolean	yes
`priority`	integer	yes
`refundable`	boolean	yes
`paymentMode`	string	yes
`cancellationWindowHours`	integer	yes
`minLeadTimeHours`	integer · nullable	yes
`maxLeadTimeDays`	integer · nullable	yes
`guestSegment`	string · nullable	yes
`inheritFromId`	string · nullable	yes
`tenantId`	string	yes
`createdAt`	string	yes

`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

Field	Type	Required	Notes
`ratePlanId`	string	no
`roomType`	string	yes
`date`	string	yes
`priceCents`	integer	yes
`currency`	string	no	Default: "EUR"

Output fields

Field	Type	Required
`id`	string	yes
`ratePlanId`	string	yes
`roomType`	string	yes
`date`	string	yes
`priceCents`	integer	yes
`currency`	string	yes

`rates.upsertRestriction`

writes

Rates: upsert restriction. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`ratePlanId`	string	no
`roomType`	string	yes
`date`	string	yes
`stopSell`	boolean	no	Default: false
`cta`	boolean	no	Default: false
`ctd`	boolean	no	Default: false
`minStay`	integer	no
`maxStay`	integer	no

Output fields

Field	Type	Required
`id`	string	yes
`tenantId`	string	yes
`ratePlanId`	string	yes
`roomType`	string	yes
`date`	string	yes
`stopSell`	boolean	yes
`cta`	boolean	yes
`ctd`	boolean	yes
`minStay`	integer · nullable	yes
`maxStay`	integer · nullable	yes
`createdAt`	string	yes
`updatedAt`	string	yes