Add or Update Booking Accommodation
Add or Update Booking Accommodation
POST [PlatformAddress]/api/1.0/venue?action=addOrUpdateBookingAccommodation
Adds or updates the details of a specific booking accommodation group on a specific venue booking. This action will fail if the booking cannot support accommodation blocks.
Booking Accommodation (Group)
id
integer
optional
The unique id of the booking accommodation to update - a new accommodation group will be created if this parameter is not present
venueId
integer
required
The unique id of the venue to which the booking belongs
bookingId
integer
required
The unique id of the booking to which the accommodation group belongs
roomVenueId
integer
required
The unique id of the venue to which the rate plan (barId) and room type (roomId) belong (can be different to venueId)
barId
integer
optional
The unique id of the rate plan assigned to the accommodation group
roomId
integer
required
The unique id of the room type assigned to the accommodation group
startDate
date
required
The arrival date of the accommodation group
endDate
date
required
The departure date of the accommodation group
overrideCapacity
boolean
optional
Whether or not the accommodation group can exceed the general room availability
cutOffDate
date
optional
The date after which changes to the accommodation group are not allowed
dayRatesActual
optional
The daily actual rates of the accommodation group
dayRatesForecast
optional
The daily forecast rates of the accommodation group
dayRatesNet
optional
The daily net rates of the accommodation group
dayRates
required on add, optional on update
The daily rates of the accommodation group
dayRatesActualMultiOcc
optional
The daily actual rates for different occupancies of the accommodation group (Only available when feature enabled in venue)
dayRatesForecastMultiOcc
optional
The daily forecast rates for different occupancies of the accommodation group (Only available when feature enabled in venue)
dayRatesNetMultiOcc
optional
The daily net rates for different occupancies of the accommodation group (Only available when feature enabled in venue)
dayRatesMultiOcc
required on add, optional on update
The daily rates for different occupancies of the accommodation group (Only available when feature enabled in venue)
excludedTaxIds
array of integers
optional
The unique ids of the taxes that are excluded from the daily rates
roomOptions
optional
The additional room options of the accommodation group
Booking Accommodation Day Rates Actual
bookingDate
date
true
The actual date of the accommodation group to which the rate applies
numRooms
integer
true
The actual number of rooms booked on bookingDate
cost
number
true
The actual rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The actual number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
Booking Accommodation Day Rates Forecast
bookingDate
date
true
The forecast date of the accommodation group to which the rate applies
numRooms
integer
true
The forecast number of rooms booked on bookingDate
cost
number
true
The forecast rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The forecast number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
Booking Accommodation Day Rates Net
bookingDate
date
true
The date of the accommodation group to which the rate applies
numRooms
integer
true
The number of rooms booked on bookingDate
cost
number
true
The rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
discount
number
The amount of discount
numPayableByGuest
integer
false
The number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
Booking Accommodation Day Rates
bookingDate
date
true
The date of the accommodation group to which the rate applies
numRooms
integer
true
The number of rooms booked on bookingDate
cost
number
true
The rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
Booking Accommodation Day Rates Actual Multi Occupancy
bookingDate
date
true
The actual date of the accommodation group to which the rate applies
numRooms
integer
true
The actual number of rooms booked on bookingDate
cost
number
true
The actual rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The actual number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
occType
integer
true
Booking Accommodation Day Rates Forecast Multi Occupancy
bookingDate
date
true
The forecast date of the accommodation group to which the rate applies
numRooms
integer
true
The forecast number of rooms booked on bookingDate
cost
number
true
The forecast rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The forecast number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
occType
integer
true
Booking Accommodation Day Rates Net Multi Occupancy
bookingDate
date
true
The date of the accommodation group to which the rate applies
numRooms
integer
true
The number of rooms booked on bookingDate
cost
number
true
The rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
discount
number
The amount of discount
numPayableByGuest
integer
false
The number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
occType
integer
true
Booking Accommodation Day Rates Multi Occupancy
bookingDate
date
true
The date of the accommodation group to which the rate applies
numRooms
integer
true
The number of rooms booked on bookingDate
cost
number
true
The rate amount for the room on bookingDate. The amount either includes or excludes tax depending on how the venue is configured
numPayableByGuest
integer
false
The number of rooms on bookingDate that are payable by guests (as opposed to the master account of the booking)
occType
integer
true
Booking Accommodation Room Option
bookingDate
date
required
The date of the accommodation group to which the additional option applies
roomOptionId
integer
required
The unique id of the room option added on bookingDate
numRooms
integer
required
The number of rooms on bookingDate to which the room option applies
priceType
integer
Optional
numOptions
integer
Optional
The number options added to each room / guest on bookingDate
numOptionsPerRoom
integer
required
The number options added to each room (numRooms) on bookingDate
price
number
required
The price of the additional option. The amount either includes or excludes tax depending on how the venue is configured
excludedTaxIds
array of integers
optional
The unique ids of the taxes that are excluded from price
costcenterId
integer
optional
The unique id of the cost center assigned to the additional option
numPayableByGuest
integer
optional
The number of additional options on bookingDate that are payable by guests (as opposed to the master account of the booking).
Price Type
One of the following values
1
Per Room
2
Per Guest
Notes on updating an accommodation group
Updating an existing accommodation group overlays the existing data. Optional request data that is excluded will not change existing data. This does not guarantee that the request data will validate if other data is changed. For example, if the end date of the accommodation is extended, rates for the new dates will be required.
If the start and/or end dates of the accommodation group change: * Any existing rates on dates that no longer apply (i.e. bookingDate is outside the new group dates) will be removed. * Any existing room options on dates that no longer apply (i.e. bookingDate is outside the new group dates) will be removed. * Rates for any new dates are required. * If the accommodation group dates extend beyond the accommodation dates of the booking (to which the group belongs) then the booking's accommodation dates will be adjusted to include the new date range.
Day rates override existing data based on the bookingDate value in the request. For example, to change the rate on 23/12/2019: { "bookingDate": "2019-12-23", "numRooms": 5, "cost": 180, "numPayableByGuest": 0 }
Room options override existing data based on the roomOptionId and bookingDate values in the request.
The same room option can only be added to the accommodation group once (this also applies when adding an accommodation group). If a room option appears multiple times in the request for the same date, the last value is used. For example: "roomOptions": [ { "bookingDate", "2019-01-01", "roomOptionId": 124, "numRooms": 4, "numOptionsPerRoom": 1, "price": 25, "excludedTaxIds": [], "numPayableByGuest": 0 }, { "bookingDate", "2019-01-01", "roomOptionId": 124, "numRooms": 6, "numOptionsPerRoom": 2, "price": 30, "excludedTaxIds": [], "numPayableByGuest": 0 } ] roomOptionId 124 on 01/01/2019 will have: numRooms 6, numOptionsPerRoom 2, price 30 etc.
To remove room options from an accommodation group, pass zero values as follows: { "bookingDate": "2019-01-01", "roomOptionId": 124, "numRooms": 0, "numOptionsPerRoom": 0, "price": 0, "excludedTaxIds": [], "numPayableByGuest": 0 }
The numRooms & numPayableByGuest values of a room option cannot exceed the numRooms value on the same bookingDate. For example, if the following day rate exists: { "bookingDate": "2019-12-23", "numRooms": 5, "cost": 180, "numPayableByGuest": 0 } Then the numRooms & numPayableByGuest values of any room option on 23/12/2019 cannot exceed 5. It is possible to update an existing accommodation group and either decrease or increase numRooms of the day rate. If the day rate numRooms is decreased, all existing room options that exceed the new value will also be decreased. If the day rate numRooms is increased, no existing room options are modified (unless the new values are passed in the request).
Last updated