Links

Get Booking

Note: Section sessions, packages, additionalItems, beveragePackages, menus, resources, products and serviceFees are not published yet.
post
[PlatformAddress]/api/1.0/venue?action=getBooking
Get Booking
The result from this call will be the details of a specific booking to which the user has access. The unique booking identifier is required, for example {“id”:123}

Example Request

{
"id":3
}

Booking

Property
Type
Description
id
integer
The unique identifier of the booking
venueId
integer
The venue identifier of the booking
code
string
A reference assigned to the booking by the venue (only unique within a single venue)
name
string
The name of the booking
eventType
string
The event type of the booking
eventTypeId
integer
The event type id of the booking
companyId
integer
The unique id of the company assigned to the booking
company
Company
The details of the company assigned to the booking
contactId
integer
The unique id of the contact assigned to the booking
contact
Contact
The details of the contact assigned to the booking
isConfidential
boolean
Whether or not the booking is confidential
currentStatus
enum
The current status of the booking. See Status
totalAmount
double
The total amount of the booking, including tax
totalTaxAmount
double
The total tax of the booking
amountOutstanding
double
The amount outstanding of the booking, including tax
accountTimezone
timezone
The timezone of the account
venueTimezone
timezone
The timezone of the venue
createdDate
timestamp
The date & time the booking was created
modifiedDate
timestamp
The date & time the booking was last modified
lastModifiedDate
timestamp
The last modified date & time the booking or its children like Accommodation, Package, Session, Additional Items, etc.
dateEventStart
timestamp
The start event date of the booking
dateEventEnd
timestamp
The end event date of the booking
convertedToTentative
timestamp
The date when booking converted to tentatvive
convertedToConfirmed
timestamp
The date when booking converted to confirmed
convertedToCancelled
timestamp
The date when booking converted to cancelled
isAccommIncluded
boolean
Whether or not the booking includes accommodation
dateAccomStart
timestamp
The start accommodation date of the booking
dateAccomEnd
timestamp
The end accommodation date of the booking
focRoomsDenominator
int
The number of accommodation rooms in which one room is complimentary. For example if the value is 5, then 1 in 5 accommodation rooms will be complimentary.
maxNumFocRoomsPerDay
int
The maximum number of accommodation rooms per day that can be complimentary
hasPackages
boolean
Whether or not the booking has packages
decisionDate
timestamp
The date before which the event/accommodation dates must be decided
canBeMoved
boolean
Whether or not the event/accommodation dates of the booking are flexible
bookedById
integer
The unique id of the event coordinator user assigned to the booking
beoNumbers
array
The id/numbers for the BEO documents assigned to the booking
isBeoFinalised
boolean
Whether or not the BEO of the booking has been finalised
beoFinalisedDate
timestamp
The date & time on which the BEO of the booking was finalised
accommReservationMethod
optional
otaFolioRef
string
The recorded Folio ID of a booking.
accommCutOffDate
timestamp
After this date no more reservations may be made against the Block for the entire date range.
accommCancellationDate
timestamp
The last date a customer can cancel their Group Accommodation without financial penalty.
accommChargingMethod
A record of the Charging Method for Documents, Note that values will still need to be altered in the Block.
accommGuaranteeRequired
boolean
Indicates whether the customer is required to guarantee their reservation with a credit card.
accommExternalBlockId
string
The Block ID from an external PMS.
dailyRevenue
Array of DailyRevenue
The daily revenue data of booking
packages
Array of Package
The list of packages of the booking
sessions
Array of Session
The list of sessions of booking
menus
Array of Menu
The list of menus of the booking
beveragePackages
Array of Beverage Package
The list of beverage packages of the booking
resources
Array of Resource
The list of resources of the booking
products
Array of Product
The list of products of the booking
additionalItems
Array of Additional Item
The list of additional items of the booking
serviceFees
Array of Service Fees
The list of service fee applied to different items of the booking
salesPersonUser
Array of Sales Person
The details of sales Person in the booking
bookedByUser
Array of Booked By
The details of the user that created the booking
leadBccEmail
string
The email address that can be used to record emails against this lead
foodBeveragePayableBy
The Food and Beverage can be payable by
totalAttendees
integer
The total number of attendees for the booking
hasCommissions
boolean
The booking pay comissions to an agent
hasCommissionPaid
boolean
The commission has been paid for the booking
agent
Array of Agent
The details of the agent in the booking
commissionByCostCentres
The commission amount by Cost Centres in the Booking
bookingType
The type of Booking selected for the Booking
opportunityId
integer
The id of the Opportunity for the Booking
hasCateringWebsite
boolean
Whether or not the catering website is enabled for the booking
cateringWebsiteLogoId
string
The catering website logo for the booking
cateringWebsiteLogo
File
The catering website logo for the booking
cateringWebsiteBannerId
string
The catering website banner for the booking
cateringWebsiteBanner
File
The catering website banner for the booking
cateringWebsiteEventDesc
string
The catering website event description for the booking
cateringWebsiteEndNumDays
integer
The catering website end num days from event start for the booking

File

Property
Type
Description
id
integer
The file identifier
accountId
integer
The account id of a file
originalFileName
string
The original file name
size
integer
Size of the file
tags
array
Tags related to the file
contentType
string
Content type of the file
url
string
Url of the file

Status

One of the following values:
#
Description
1
Prospective
2
Tentative
3
Confirmed
4
Cancelled
5
Ordering
8
Not Accepted
9
Prospective Hold

Daily Revenue

Property
Type
Description
venueId
integer
The unique identifier of the venue to which the cost center belongs
costcenterId
integer
The unique identifier of the cost center to which the revenue applies
revenueDate
Date
The date on which the revenue applies
totalAmount
double
The total revenue amount, including tax
totalDiscountAmount
number
The amount of total discount
totalTaxAmount
double
The total tax amount that is included in the total revenue amount

Company

Property
Type
Description
id
integer
The unique identifier of the company
businessName
integer
The business name of the company

Contact

Property
Type
Description
id
integer
The unique identifier 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 phone number of the contact

Package

Property
Type
Description
id
integer
The unique identifier for the booking package
bookingDate
Date
The date of the package
numberAttendees
integer
The number of attendees for the booking package
price
double
The price of the booking package
createdDate
timestamp
The date and time when the booking package was added to this booking
modifiedDate
timestamp
The date and time when the booking package was last modified
totalAmount
double
The total amount of the booking package including tax amount
totalDiscount
double
The total amount of the discount
totalSurcharge
double
The total amount of the surcharge
totalTaxAmount
double
The tax amount of the booking package
priceMethod
The price method of the booking package
costcenters
The list of costcenter and its individual value of the booking package
taxDetails
Array of Tax Detail
Individual tax details
smallDescription
string
The small description of the booking package
packageId
string
The id of the venue package
packageName
string
The name of the venue package

Package Price Method

Value
Description
1
Per Person
2
Flat Rate

Package Cost Center

Property
Type
Description
costcenterId
integer
The unique identifier of the cost center
value
double
The amount of the cost center
discount
double
The amount of the discount on value
surcharge
double
The amount of the surcharge on value
excludedTaxIds
array
The excluded tax identifiers
totalAmount
double
The amount of the cost center
totalSurcharge
double
The amount of the total surcharge
totalTaxAmount
double
The total tax amount of the cost center
taxDetails
Array of Tax Detail
The individual tax amount

Session

Property
Type
Description
id
integer
The unique identifier of the session
name
string
The name of the session
startDate
Date
The start date of the session
endDate
Date
The end date of the session
startTime
Time
The start time of the session
endTime
Time
The end time of the session
spaceVenueId
integer
The id of the venue to which the space (spaceId) belongs (it can be different to the booking's venueId)
spaceId
integer
The space identifier booked by the session
spaceLayout
integer
The space layout identifier of the session
customLayoutName
string
The space layout name when space layout is custom
cost
double
The cost of the session
discount
double
The amount of the discount on cost
totalAmount
double
The total amount of session including tax amount
totalDiscount
double
The total amount of the discount
totalSurcharge
double
The total amount of the surcharge
totalTaxAmount
double
The tax amount of the session
excludedTaxIds
array
The excluded tax identifiers of the session
costcenterId
integer
The cost center identifier to which the session's revenue applies
includeInPackage
boolean
Whether or not the booking session is included in booking package
bookingPackageId
integer
The booking package identifier if the booking session is included in package
beoNumbers
array
The id/numbers of the BEO documents assigned to the booking session
createdDate
timestamp
The date and time when the session was created
modifiedDate
timestamp
The date and time when the session was last modified
taxDetails
Array of Tax Detail
Individual tax details
totalAttendees
integer
The minimum number of attendees for the Booking session
Property
Type
Description
id
integer
The unique identifier of the menu
name
string
The name of the menu
menuVenueId
integer
The venue identifier to which the menu package belongs. This can be different than booking's venue id
menuId
integer
The reference menu identifier in venue menus
menuTypeCategory
The reference menu category identifier in venue menus
sessionId
integer
The session identifier to which this menu belongs
cost
double
The cost of the menu
discount
double
The amount of the discount on cost
surcharge
double
The amount of the surcharge on cost
excludedTaxIds
array
The excluded tax identifiers
startDate
Date
The start date of the menu
endDate
Date
The end date of the menu
startTime
Time
The start time of the menu
endTime
Time
The end time of the menu
includeInPackage
boolean
Whether or not the menu is included in booking package
bookingPackageId
integer
The booking package identifier if menu is included in package
createdDate
timestamp
The date and time the menu was created
modifiedDate
timestamp
The date and time the menu was last modified
costcenterId
integer
The cost center identifier to which the revenue applies
totalAmount
double
The total amount of the menu including tax
totalDiscount
double
The total amount of the discount
totalSurcharge
double
The total amount of the surcharge
totalTaxAmount
double
The tax amount of the menu
taxDetails
Array of Tax Detail
Individual tax details
totalAttendees
integer
The minimum number of attendees for the menu
costcenters
array of Costcenter
optional

Beverage Package

Property
Type
Description
id
integer
The unique identifier of the beverage package
name
string
The name of the beverage package
sessionId
integer
The session identifier to which this beverage package belongs
beverageVenueId
integer
The venue identifier to which the beverage package belongs. This can be different than booking's venue id
beverageId
integer
The reference beverage package identifier in venue beverage packages
cost
double
The cost of the beverage package
discount
double
The amount of the discount on cost
surcharge
double
The amount of the surcharge on cost
excludedTaxIds
array
The excluded tax identifiers
startDate
Date
The start date of the beverage package
endDate
Date
The end date of the beverage package
startTime
Time
The start time of the beverage package
endTime
Time
The end time of the beverage package
includeInPackage
boolean
Whether or not the beverage package is included in booking package
bookingPackageId
integer
The booking package identifier if beverage package is included in package
createdDate
timestamp
The date and time the beverage package was created
modifiedDate
timestamp
The date and time the beverage package was last modified
costcenterId
integer
The cost center identifier to which the revenue applies
totalAmount
double
The total amount of the beverage package including tax
totalDiscount
double
The total amount of the discount
totalSurcharge
double
The total amount of the surcharge
totalTaxAmount
double