Comment on page

Get Booking Room Reservation List

post
[PlatformAddress]/api/1.0/venue?action=getBookingRoomReservationList
Get Booking Room Reservation List
The result from this call will be a collection of booking room reservation records the user has access to. This call also accepts the pagination and filter properties.
Booking Room Reservation
Property
Type
Description
id
integer
The unique id of the booking room reservation
venueId
integer
The unique id of the venue to which the booking belongs
bookingId
integer
The unique id of the booking to which the room reservation belongs
canBeEdited
boolean
Whether or not changes to the booking room reservation are allowed
reference
integer
A unique reference assigned to the room reservation
mainGuestId
integer
The unique id of the main guest of the reservation
mainGuest
​Guest​
Details of the main guest of the room reservation
currentStatus
integer
The current status of the room reservation
cancelledDate
datetime
The date & time the room reservation was cancelled
isFromGroup
boolean
Whether or not the room reservation applies to an accommodation group​
totalAmount
number
The total amount of the room reservation. The amount either includes or excludes tax depending on how the venue is configured
createdDate
datetime
The date & time the room reservation was created
modifiedDate
datetime
The date & time the room reservation was last modified
rooms
array of Reserved Rooms​
The details of the rooms that have been reserved
Room Reservation Status
Status
Description
1
Not confirmed
2
Confirmed
3
Cancelled
4
Checked In
5
Checked Out
Reserved Room
Property
Type
Description
id
integer
The unique id of the reserved room
guestId
integer
The unique id of the venue guest
guest
​Guest​
Details of the guest assigned to the reserved room
barId
integer
The unique id of the rate plan assigned to the reserved room. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the rate plan assigned to the accommodation group
roomId
integer
The unique id of the room type that is reserved. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the room type assigned to the accommodation group
groupId
integer
The unique id of the accommodation group from which the room is reserved (see property isFromGroup above)
currentStatus
integer
The current status of the reserved room
numRooms
integer
The number of rooms reserved. This value is always 1
arrivalDate
date
The arrival date of the reserved room
departureDate
date
The departure date of the reserved room
totalAmount
number
The total amount of the reserved room. The amount either includes or excludes tax depending on how the venue is configured
excludedTaxIds
array of integers
The unique ids of the taxes that are excluded from the daily rates
numAdultGuests
integer
The number of adults on the reserved room
numChildGuests
integer
The number of children on the reserved room
createdDate
datetime
The date & time the reserved room was created
modifiedDate
datetime
The date & time the reserved room was last modified
isCancelled
boolean
Whether or not the reserved room is cancelled
cancelledDate
datetime
The date & time the reserved room was cancelled
dayRates
array of Day Rates​
The daily rates of the reserved room
additionalGuests
array of Additional Guests​
The additional guests of the reserved room
overrideBlockCapacity
boolean
Whether or not the number of reservations can exceed the block
occType
integer
The occupancy type of the reserverd room See Occupancy Type​
Reserved Room Status
Status
Description
1
Not confirmed
2
Confirmed
3
Cancelled
4
Checked In
5
Checked Out
Reserved Room Day Rates
Property
Type
Description
dayDate
date
The date of the reserved room to which the rate applies
barId
integer
The unique id of the rate plan assigned to the dayDate of the reserved room. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the room type assigned to the accommodation group
cost
number
The rate amount for the reserved room on dayDate. The amount either includes or excludes tax depending on how the venue is configured
Reserved Room Additional Guests
Property
Type
Description
guestId
integer
The identifier of guest being updated on the reserved room
guest
​Guest​
The additional guest details for the reserved room
arrivalDate
date
The arrival date of the additional guest
departureDate
date
The departure date of the additional guest
guestType
enum
The sharing type of additional guest. See Additional Guest Type​
Guest
Property
Type
Description
id
integer
The unique id of the venue guest
guestContact
​Contact​
The contact details of the guest
primaryPhone
string
The primary phone number of the guest
address
​Address​
The address of the guest
isAnonymised
boolean
Whether or not the guest details have been anonymised
createdDate
datetime
The date & time the venue guest was created
modifiedDate
datetime
The date & time the venue guest was last modified
Guest Contact Details
Property
Type
Description
id
integer
The unique id of the contact​
firstName
string
The first name of the contact
lastName
string
The last name of the contact
email
string
The email address of the contact
phone
string
The mobile phone number of the contact
createdDate
datetime
The date & time the contact was created
modifiedDate
datetime
The date & time the contact was last modified

Property	Type	Description
id	integer	The unique id of the booking room reservation
venueId	integer	The unique id of the venue to which the booking belongs
bookingId	integer	The unique id of the booking to which the room reservation belongs
canBeEdited	boolean	Whether or not changes to the booking room reservation are allowed
reference	integer	A unique reference assigned to the room reservation
mainGuestId	integer	The unique id of the main guest of the reservation
mainGuest	Guest	Details of the main guest of the room reservation
currentStatus	integer	The current status of the room reservation
cancelledDate	datetime	The date & time the room reservation was cancelled
isFromGroup	boolean	Whether or not the room reservation applies to an accommodation group
totalAmount	number	The total amount of the room reservation. The amount either includes or excludes tax depending on how the venue is configured
createdDate	datetime	The date & time the room reservation was created
modifiedDate	datetime	The date & time the room reservation was last modified
rooms	array of Reserved Rooms	The details of the rooms that have been reserved

Status	Description
1	Not confirmed
2	Confirmed
3	Cancelled
4	Checked In
5	Checked Out

Property	Type	Description
id	integer	The unique id of the reserved room
guestId	integer	The unique id of the venue guest
guest	Guest	Details of the guest assigned to the reserved room
barId	integer	The unique id of the rate plan assigned to the reserved room. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the rate plan assigned to the accommodation group
roomId	integer	The unique id of the room type that is reserved. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the room type assigned to the accommodation group
groupId	integer	The unique id of the accommodation group from which the room is reserved (see property isFromGroup above)
currentStatus	integer	The current status of the reserved room
numRooms	integer	The number of rooms reserved. This value is always 1
arrivalDate	date	The arrival date of the reserved room
departureDate	date	The departure date of the reserved room
totalAmount	number	The total amount of the reserved room. The amount either includes or excludes tax depending on how the venue is configured
excludedTaxIds	array of integers	The unique ids of the taxes that are excluded from the daily rates
numAdultGuests	integer	The number of adults on the reserved room
numChildGuests	integer	The number of children on the reserved room
createdDate	datetime	The date & time the reserved room was created
modifiedDate	datetime	The date & time the reserved room was last modified
isCancelled	boolean	Whether or not the reserved room is cancelled
cancelledDate	datetime	The date & time the reserved room was cancelled
dayRates	array of Day Rates	The daily rates of the reserved room
additionalGuests	array of Additional Guests	The additional guests of the reserved room
overrideBlockCapacity	boolean	Whether or not the number of reservations can exceed the block
occType	integer	The occupancy type of the reserverd room See Occupancy Type

Status	Description
1	Not confirmed
2	Confirmed
3	Cancelled
4	Checked In
5	Checked Out

Property	Type	Description
dayDate	date	The date of the reserved room to which the rate applies
barId	integer	The unique id of the rate plan assigned to the dayDate of the reserved room. If the reserved room applies to an accommodation group (see property isFromGroup above) then this will always be the room type assigned to the accommodation group
cost	number	The rate amount for the reserved room on dayDate. The amount either includes or excludes tax depending on how the venue is configured

Property	Type	Description
guestId	integer	The identifier of guest being updated on the reserved room
guest	Guest	The additional guest details for the reserved room
arrivalDate	date	The arrival date of the additional guest
departureDate	date	The departure date of the additional guest
guestType	enum	The sharing type of additional guest. See Additional Guest Type

Property	Type	Description
id	integer	The unique id of the venue guest
guestContact	Contact	The contact details of the guest
primaryPhone	string	The primary phone number of the guest
address	Address	The address of the guest
isAnonymised	boolean	Whether or not the guest details have been anonymised
createdDate	datetime	The date & time the venue guest was created
modifiedDate	datetime	The date & time the venue guest was last modified

Property	Type	Description
id	integer	The unique id of the contact
firstName	string	The first name of the contact
lastName	string	The last name of the contact
email	string	The email address of the contact
phone	string	The mobile phone number of the contact
createdDate	datetime	The date & time the contact was created
modifiedDate	datetime	The date & time the contact was last modified

Remove Booking Accommodation

Add or Update Booking Room Reservation

Last modified 5mo ago