All Classes and Interfaces
Class
Description
Address information
Address information
List of room configuration booking requests.
Primitive aggregate data points
Aggregate function
Extra reservations of spas, meeting rooms etc that should accompany the room type booking.
Inventory type
The authenticated user ID that made the payment request
The authenticated user ID that made the payment request
BedAgent
BedBooker
BedroomAgent
Type of bedroom
BedroomBooker
Type of bedroom
Desired bedroom layout
Desired bedroom layout
BeneficiaryAgent
The type of beneficiary payment.
BeneficiaryBooker
The type of beneficiary payment.
A variable charge can be a fixed amount or a percentage.
Gets or Sets type
A variable charge can be a fixed amount or a percentage.
Gets or Sets type
Booking data object
Communicates whether the booking was created normally or if it failed or was just for testing.
Convenience data point to show which status the booking currently has.
Spa reservation records.
Pricing type
Inventory type
Spa reservation records.
Pricing type
Inventory type
Booking data object
Communicates whether the booking was created normally or if it failed or was just for testing.
Convenience data point to show which status the booking currently has.
BookingConfirmationsAgent
Booking contract created by TripPay
Reason type.
Type of entity that cancelled the booking.
Booking contract created by TripPay
Reason type.
Type of entity that cancelled the booking.
Returns the lodging item only.
When to charge for this item.
How to calculate the total amount.
Type of item this is.
Returns the lodging item only.
When to charge for this item.
How to calculate the total amount.
Type of item this is.
Payment details the merchant provided us at the time of payment.
Unique transaction id from the vendor upon a successful sale.
Name of acquiring vendor
Payment details the merchant provided us at the time of payment.
Unique transaction id from the vendor upon a successful sale.
Name of acquiring vendor
Address entered during booking process
Address entered during booking process
User details for the authenticated person that made the booking.
User details for the authenticated person that made the booking.
User object contains details of the person that made the booking.
BookingViewAgent
BookingViewBooker
Boolean response
CancellationDetailBooker
Cancellation type
Based on the itinerary, the cancellation policy could be taken directly from the rate plan or it could be a policy exception also listed on the rate plan
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline.
In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Based on the itinerary, the cancellation policy could be taken directly from the rate plan or it could be a policy exception also listed on the rate plan
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline.
In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
CancellationPolicyExceptionAgent
CancellationPolicyExceptionBooker
Allows a property to dynamically use another cancellation policy for a specific date range
Allows a property to dynamically use another cancellation policy for a specific date range
Child configuration
Child configuration
List of all travel inventory entries that are due a commission to the affiliate.
Gets or Sets type
List of all travel inventory entries that are due a commission to the affiliate.
Gets or Sets type
Descriptors used for filtering result set
Whether to filter inclusively or exclusively
Travel inventory contact (if applicable)
Travel inventory contact (if applicable)
Country
Country
CreateAgentBookingRequestAgent
CustomMonetaryAmount
In case of LODGING, include daily rates
In case of LODGING, include daily rates
DowPatternGroupAgent
DowPatternGroupBooker
Which engine configuration record did the entity application used to facilitate in making this booking happen.
Sales channel sub-type.
Action to complete once a user clicks on the CTA button on inventory.
Which engine configuration record did the entity application used to facilitate in making this booking happen.
Sales channel sub-type.
Action to complete once a user clicks on the CTA button on inventory.
Choose how you want our web components to look and more closely match with your own site style.
Choose how you want our web components to look and more closely match with your own site style.
List of extra charges that applies to the rate plan.
List of extra charges that applies to the rate plan.
Rate plan-level extra charges
Rate plan-level extra charges
Fees associated with this booking contract.
Type of fee
Fees associated with this booking contract.
Type of fee
Descriptors used for filtering the result set
Filter operator to use on field
General manager related data.
General manager related data.
Generic error message
GeoJsonLineStringAgent
GeoJsonLineStringBooker
Geo-location point where inventory takes place.
Geo-location point where inventory takes place.
Map bounds the user is looking.
Map bounds the user is looking.
GeoNames have been created at [https://geonames.org](https://geonames.org) and contain geographical destinations we use as geoname data to associate travel inventory with a location.
GeoName type
GeoNames have been created at [https://geonames.org](https://geonames.org) and contain geographical destinations we use as geoname data to associate travel inventory with a location.
GeoName type
Descriptors to group result sets by.
Group sort direction
Guest room details.
Indicate the type of lifestyle this inventory should be associated with.
Level of expensiveness.
Used to request or specify a gender assignment for a room.
Guest room details.
Indicate the type of lifestyle this inventory should be associated with.
Level of expensiveness.
Used to request or specify a gender assignment for a room.
GuestUserAgent
GuestUserBooker
Combined property data.
A list of lifestyles the property associates with.
Combined property data.
A list of lifestyles the property associates with.
Whether image has attribution properties
Whether image has attribution properties
IPLocationAgent
IPLocationBooker
ItineraryAgent
ItineraryBooker
Class that add parsing/formatting support for Java 8+
OffsetDateTime class.List of localized descriptions for this fee.
List of localized descriptions for this fee.
Pricing information for this ancillary.
Pricing information for this ancillary.
PageableObjectBooker
PageBookingViewBooker
Payout keeps track of all outgoing funds for a certain account.
Status of withdrawal.
Type of withdrawal.
Name of integration vendor
Payout keeps track of all outgoing funds for a certain account.
Status of withdrawal.
Type of withdrawal.
Name of integration vendor
Fees incurred when making the withdrawal.
Who pays for this fee
Type of fee
Fees incurred when making the withdrawal.
Who pays for this fee
Type of fee
Detailed customer information for this profile
Identifier the gender of the customer.
Marital status of the traveler.
Detailed customer information for this profile
Identifier the gender of the customer.
Marital status of the traveler.
Array of customer's pets
Array of customer's pets
PointAgent
PointBooker
Customer preferences
Customer preferences
A user profile accompanies this booking IF user has created and enabled sharing of profile
A user profile accompanies this booking IF user has created and enabled sharing of profile
User details
User details
Outlines basic policies for the property.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
Outlines basic policies for the property.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
The quote used to create totalCapturePrice.
The quote used to create totalCapturePrice.
Rate plan used for this stay
Rate plan used for this stay
What the guest is paying extra for
Rate plan fee type
What the guest is paying extra for
Rate plan fee type
Refund objects allow you to refund a charge that has previously been created but not yet refunded.
The type of refund determines how the funds are deducted each beneficiary.
Whether to cancel the booking alongside requesting a refund.
A description of the refund that can be displayed to booker
Status of the refund request
The entity making the refund request
Status of the refund
Refund objects allow you to refund a charge that has previously been created but not yet refunded.
The type of refund determines how the funds are deducted each beneficiary.
Whether to cancel the booking alongside requesting a refund.
A description of the refund that can be displayed to booker
Status of the refund request
The entity making the refund request
Status of the refund
Displays ancillary accounting details
The type
Displays ancillary accounting details
The type
Displays rate accounting details
Displays rate accounting details
Displays extra charge accounting details.
Displays extra charge accounting details.
User review created by the traveler after the booking completed.
ReviewAnswerAgent
Question category
ReviewAnswerAuthenticatedEntity
Question category
ReviewAnswerBooker
Question category
ReviewAnswerOptionAuthenticatedEntity
ReviewAuthenticatedEntity
User review created by the traveler after the booking completed.
Questions to be answered by booker
Gets or Sets category
ReviewTemplateAuthenticatedEntity
User details of creator of booking.
User details of creator of booking.
User details of creator of booking.
ReviewViewAuthenticatedEntity
Room Configuration
Room Configuration
All information about the room that was booked.
List of perks that came with the master rate
All information about the room that was booked.
List of perks that came with the master rate
How user likes to have results displayed
A user can filter inventory on a lifestyle
How user likes to have results displayed
A user can filter inventory on a lifestyle
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
SimpleDescriptionAgent
SimpleDescriptionBooker
Multimedia that contains less information than Multimedia object
Associate this media with a specific lifestyle type.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Multimedia that contains less information than Multimedia object
Associate this media with a specific lifestyle type.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Social network
Type of social network.
Social network
Type of social network.
Descriptors used for sorting result set.
Descriptors used for sorting result set
SortObjectBooker
StateBooker
Price details
Price details
Country subdivision such as a state or province
Country subdivision such as a state or province
SubmitReview400Response
SubmitReviewAnswerAuthenticatedEntity
Question category
SubmitReviewRequestAuthenticatedEntity
Country sub sub division
Country sub sub division
SupplierContractItemPolicyAgent
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline.
In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
SupplierContractItemPolicyBooker
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline.
In case the 'Refundable cancellation charge' is set, a different no show charge can be applied.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Recognition for the ancillary inventory.
Recognition category.
Type of rating system the recognition operated on.
Recognition for the ancillary inventory.
Recognition category.
Type of rating system the recognition operated on.
User session information containing itinerary and other user related data.
User session information containing itinerary and other user related data.