Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
AdditionalFees

Update existing additional fee

patch/additional-fees/{id}

Path parameters

idstring required

id of item to update

Request body

namestring
type'ADDITIONAL_BED' | 'AIR_CONDITIONING' | 'EARLY_CHECK_IN' | 'LATE_CHECK_IN' | 'BABY_BED' | 'CLEANING' | 'CLUB_CARD' | 'CONCIERGE' | 'EARLY_CHECKOUT' | 'LATE_CHECKOUT' | 'DEPOSIT' | 'ELECTRICITY' | 'FOOD' | 'HEATING' | 'INTERNET' | 'LAUNDRY' | 'LINENS' | 'TOWELS' | 'MANAGEMENT' | 'OIL' | 'PARKING' | 'PET' | 'POOL' | 'POOL_HEATING' | 'RESORT' | 'SERVICE' | 'TOILETRIES' | 'TOUR' | 'TRANSPORTATION' | 'CAR_RENTAL' | 'WATER' | 'WOOD' | 'TRANSFER' | 'HOUSEKEEPING' | 'INSURANCE' | 'COMMUNITY' | 'CREDIT_CARD_PROCESSING_FEE' | 'DAMAGE_WAIVER' | 'VIP_SERVICES' | 'PAYMENT_FEE' | 'ADDITIONAL_CHARGE' | 'MISCELLANEOUS' | 'SHIPPING' | 'VALET' | 'ACTIVITIES' | 'FLIGHTS' | 'GIFT_BASKET' | 'SPA' | 'CHEF' | 'MEET_AND_GREET' | 'DOCK_FEE' | 'UTILITY_FEE' | 'HOT_TUB' | 'BOOKING_FEE' | 'BREAKFAST' | 'BEVERAGE' | 'MEAL' | 'WELLNESS' | 'MINIBAR' | 'BUSINESS_CENTER' | 'WIFI' | 'GUEST_SERVICE' | 'COMMISSION_CHARGE' | 'EQUIPMENT_RENTAL' | 'RESERVATION_FEE' | 'DAMAGE_CHARGE' | 'HOMEOWNERS_ASSOCIATION' | 'GOLF_CART_RENTAL' | 'GUESTY_BASIC_TRAVEL_COVERAGE' | 'GUESTY_EXTENDED_TRAVEL_COVERAGE'

Additional fee type. !!! Not all additional fee types can be synced with channels. If you select the additional fee type which cannot be synced with channels, and 'isSyncToSupportedChannelsEnabled' is [true] you will receive a validation error. GUESTY_BASIC_TRAVEL_COVERAGE and GUESTY_EXTENDED_TRAVEL_COVERAGE can't be synced with channels. This fee types are relevant only to users who purchased Guesty’s Travel Insurance Product and can only be defined as an upsell for guests to purchase.

valueinteger
  1. Must be bigger than 0,
  2. when 'isPercentage' is 'true' then must be smaller or equal to 100
isPercentageboolean

Sets wether 'value' should be a fixed amount or percentage

targetFee'PAYOUT' | 'CLEANING_FEE' | 'ACCOMMODATION_FARE'
  1. The fee to use for the additional fee amount calculation when 'isPercentage' is 'true',
  2. required when 'isPercentage' is 'true'
multiplier'PER_NIGHT' | 'PER_GUEST' | 'PER_GUEST_PER_NIGHT' | 'PER_STAY'
  1. Specifies the factor by which the 'value' will be multiplied in the additional fee amount calculation when 'isPercentage' is 'false'.
  2. This is required when 'isPercentage' is 'false'.
isSyncToSupportedChannelsEnabledboolean
  1. Sync fee to account or listing settings and all future reservations for supported booking channels. !!! Not all additional fee types can be synced with channels. If you select the additional fee type which cannot be synced with channels, and 'isSyncToSupportedChannelsEnabled' is [true] you will receive a validation error
isAutomatedboolean
  1. Indicates if there are booking channels in which the additional fee should be added automatically to reservations once the reservation arrives in Guesty,
  2. if set to 'true', you must configure at least one of 'allSources', 'automationSources', 'allPlatforms', 'automationPlatforms', 'allRUSources', 'RUSources'
allPlatformsboolean
  1. If 'true' then the additional fee will be added to all future reservations in Guesty for all booking channels,
  2. can not be 'true' when 'isAutomated' is 'false',
  3. can not be 'true' when 'automationPlatforms' is not empty
automationPlatformsstring[]
  1. Additional fee will be added to future reservations in Guesty for specified booking channels,
  2. can not contain values when 'isAutomated' is 'false',
  3. can not contain values when 'allPlatforms' is 'true'
allSourcesboolean
  1. If 'true' then the additional fee will be added to all future reservations for all manual sources,
  2. Can not be 'true' when 'isAutomated' is 'false',
  3. Can not be 'true' when 'automationSources' is not empty
automationSourcesstring[]
  1. Additional fee will be added to future reservations in Guesty for specified manual sources,
  2. Can not contain values when 'isAutomated' is 'false',
  3. Can not contain values when 'allSources' is 'true'
allRUSourcesboolean
  1. If 'true' then the additional fee will be added to all future rentals united reservations in Guesty for all rentals united booking channels,
  2. Can not be 'true' when 'isAutomated' is 'false'
  3. Can not be 'true' when 'RUSources' is not empty,
  4. when 'true' then 'rentalsUnited' must be included in 'automationPlatforms' or 'allPlatforms' must be 'true'
RUSourcesstring[]
  1. additional fee will be added to future rentals united reservations in Guesty for specified rentals united booking channels,
  2. Can not contain values when 'isAutomated' is 'false',
  3. Can not contain values when 'allRUSources' is 'true',
  4. when not empty then 'rentalsUnited' must be included in 'automationPlatforms' or 'allPlatforms' must be 'true'
isDeductedboolean

[Beta] 1. Additional fee will be deducted from Accommodation Fare. isDeducted must be [false] without isBundled being [true] when either isSyncToSupportedChannelsEnabled, isAutomated are [true].

isBundledboolean

[Beta] 1. Additional fee value bundles/adds to Accommodation Fare, line item will not be created. When isBundled is [true] isDeducted and isSyncToSupportedChannelsEnabled must be [true], isAutomated must be [false].

isUpsellboolean

[Beta] Upsell fee on the booking website

Response

Updated additional fee item