AdditionalRatePlanInfo

Additional information about a listing's rates.

Properties

Name Description Type
feesAndTaxes A description of the listing's fees and taxes String
notes Additional information regarding the owner's rental rates such as Tax ID and disclaimers. String
paymentTerms A description of the listing's payment terms and conditions String

AdvertiserInfo

Properties

Name Description Type
advertiserNumber The advertiser number Int
externalId For Advertisers from an external system, this field can contain the unique identifier for the Advertiser. String
site The Site on which the advertiser currently logs in. Site

CancellationPolicy

Properties

Name Description Type
cancellationPolicyItems Hydrated list of Cancellation Policy Items. Used during bulk sync and /hydrated retrieval CancellationPolicyItem
description A generic description or note on the Cancellation Policies. String

CancellationPolicyItem

Properties

Name Description Type
amount If not a percent penalty then amount that will be deducted. Money
deadline The Period in which this cancellation policy is applied. The deadline should be before or on arrival date. DateTime
externalId Reference Id in external system. SOR information for external system. Can be used for searching. String
penaltyType Type of penalty. Defines the business logic. String
percentPenalty Percent of amount will be deducted as a Penalty. Decimal

ConversationMessage

A single message in a conversation thread.

Properties

Name Description Type
attachments List of attachments in the message (List) MessageAttachment
attributes Attributes about the message (List) MessageAttribute
date Date of the message in epoch time DateTime
from Who the message is from ConversationParticipant
id Message ID String
message Body of the message String
read Read/unread flag Boolean
typeKey String

ConversationParticipant

A participant in a conversation.

Properties

Name Description Type
firstName First name of the participant String
lastName Last name of the participant String
role Role of the participant String

CreateReviewRequest

Payload required in order to submit a review for a listing.

Properties

Name Description Type
arrivalDate The date of arrival for the stay in the YYYY-MM-DD format String
body textual content of the review String
headline A short summary about the stay. String
listingId A listing id as supplied by this open API String
locale String representation of the Locale that the review was written in. String
rating An overall rating for the stay between 1 and 5 Int
unitId The unit Id within the listing that the review is for String

DateRange

A range of dates.

Properties

Name Description Type
beginDate The beginning date of the range. Date
endDate The end date of the range. Date

Dimension

A Dimension associated with a MediaItem

Properties

Name Description Type
height The height. Int
width The width. Int

Fee

Fee applied in the quote

Properties

Name Description Type
amount Fee amount Money
feeType Type of fee to be charged. String
name Name of the fee String
taxes Taxes Tax

Filter

A container that holds a collection of links, where each link points at the same listing search, but filtered by one of the various possible values for this filter. A link where this filter is removed from the search entirely is also provided. This container is provided as a convenience so that clients will not have to manually build up these urls when toggling a filter. For example, given the status filter which can be one of "ENABLED" or "DISABLED" and the search https://ws.homeaway.com/public/myListings?locale=en&page=1&filterStatus=ENABLED, the filter would contain two urls. One with the other possible value for this filter (https://ws.homeaway.com/public/myListings?locale=en&page=1&filterStatus=DISABLED), and one with this filter removed (https://ws.homeaway.com/public/myListings?locale=en&page=1).

Properties

Name Description Type
links A list of FilterLink objects, where each link points to a listing search that varies the value of this filter. FilterLink
name The name of the filter that is varied in the links in this container. E.g. "ListingStatus" String

ImageFileBean

Properties

Name Description Type
height Int
imageSize String
secureUri String
uri String
width Int

Inbox

A page of conversations.

Properties

Name Description Type
entries List of conversations on this page. (List) InboxEntry
nextPage Url to the next page, or null if there is no next page. String
page The page number. Int
pageSize The number of entries per page. Int
prevPage Url to the previous page, or null if there is no previous page. String
size Total size of the inbox across all pages. Int

InboxConversation

A thread of messages between an owner and traveler.

Properties

Name Description Type
availabilityKey Boolean
checkinDate Check-in date for this stay LocalDate
checkoutDate Check-out date for this stay LocalDate
conversationUrl Url to the conversation String
created When was this created DateTime
expirationDateTime expiration date DateTime
flexibleDates Are the stay's dates flexible Boolean
id Id of this conversation String
inquirySource The source of the inquiry String
invoiceExists Does an invoice exist Boolean
listingUrl Url to the listing String
messages The list of messages in the conversation (List) ConversationMessage
numAdults number of adults for this stay Int
numChildren number of children for this stay Int
owner The owner of the listing ConversationParticipant
ownerMarkedSpam Has the owner marked this as spam Boolean
ownerResponded Has the owner responded Boolean
reservation A summary about the reservation ListingReservationSummary
reviewRequestSent Has a listing review request been sent Boolean
status Status of the conversation String
traveler The traveler in the conversation ConversationParticipant

InboxEntry

An abbreviated version of a single conversation, tailored for viewing as an entry in an inbox. Contains metadata about the conversation plus the last message that was sent.

Properties

Name Description Type
archived Is this entry archived Boolean
conversationUrl Url to get the conversation String
correspondent The person on the other side of the conversation ConversationParticipant
created When was this entry created DateTime
expirationDateTime Expiration date DateTime
flexibleDates Are the stay dates flexible Boolean
id the id of the inbox entry String
inquiryComments Comments associated with the original inquiry String
inquirySource What was the source of the inquiry String
lastMessage The last message in the conversation ConversationMessage
lastMessageReceivedDate When was the last message received for this conversation DateTime
listingUrl A link to the listing this conversation is about String
numAdults number of adults for this stay Int
numChildren number of children for this stay Int
ownerMarkedSpam Has the owner marked this as spam Boolean
ownerResponded Has the owner responded Boolean
reservationDistributionChannel The distribution channel of the reservation String
reservationReferenceNumber The reservation reference number String
reservationSource What was the source of the reservation String
status Status of this entry String
stayEndDate The end date of the stay LocalDate
stayStartDate The start date of the stay LocalDate
unreadMessages Does this have unread messages Boolean

ListingAd

Information about a listing that advertises a vacation rental.

Properties

Name Description Type
adContent Descriptive content about the vacation rental. ListingAdContent
availabilityUpdated When was the listing's availability was last updated DateTime
features Structured information about the "features" of this listing, including information about the home, amenities, and nearby attractions. ListingAdFeature
listingId Listing id. String
listingUrl A link to the live property page on the HomeAway website. String
location Information about the location of the vacation rental. ListingLocation
photos Thumbnails and photos associated with the vacation rental. ListingAdPhotos
sites A list of links that the listing is published on. An empty or null value for a site link means there is no url template for that site, therefore we cannot determine the correct site url. Link
sourceLocale The locale this listing was originally entered in. String
sourceLocaleName Localized display name for sourceLocale. String
units A Unit is an advertisement for a single unit of a vacation rental property. The Unit describes a single rentable unit of a vacation rental property (e.g. a guest house can be a separate unit from the main house.) Details of the property in general, such as location, are contained in the Listing that owns the Unit. (List) ListingUnit

ListingAdContent

Container for human-readable descriptions of this property.

Properties

Name Description Type
accommodationsSummary A textual summary of the accommodations that the property provides. String
description A textual description of the property. String
headline A headline for the advertisement. String

ListingAdFeature

A structured piece of information about some aspect of this property. Features include information about the home and its rooms, amenities, nearby attractions, etc.

Properties

Name Description Type
category The FeatureSet of which this Feature is a member. String
count The quantity of this feature (e.g. 2 fireplaces). Int
description String
localizedName The localized name. The locale of the text elements may or may not have a country. Country-specific text should take precedence. String

ListingAdHeadlinePhoto

The primary photo for a listing.

Properties

Name Description Type
photo The photo including all sized images ListingAdPhoto
unitNumber The unit number for the unit Int

ListingAdPhoto

A photo for a listing.

Properties

Name Description Type
caption Caption for the photo. String
large PhotoImage
medium PhotoImage
originalDimension The dimensions of the original uploaded image. Dimension
small PhotoImage

ListingAdPhotos

A container of photos for a listing.

Properties

Name Description Type
photos List of all available photos ListingAdPhoto
thumbnails List of all available thumbnails ListingAdHeadlinePhoto

ListingAdRoom

Information about a room.

Properties

Name Description Type
amenities The amenities offered by the room. (List) ListingAdFeature
name The name of the room - can be used to differentiate multiple rooms of the same type (e.g. "Master Bathroom"). String
note A textual note about the room. String
roomSubType The type of the room. String

ListingLegacyId

Legacy identifier for a listing.

Properties

Name Description Type
listingNamespace ListingNamespace
listingNumber Int

ListingLocation

The geographical location of a rental.

Properties

Name Description Type
city The city the listing is located in String
country The country the listing is located in String
lat The latitude coordinate. Decimal
lng The longitude coordinate. Decimal
state The state/region/province the listing is located in String

ListingReservationsPaginator

A page of results for a reservations search.

Properties

Name Description Type
entries The actual results on this page. (List) ListingReservationSummary
filters A collection of urls pointing to the results of this search, but with different filters applied. For more info see Filter
listingId The id of the listing for these reservations. String
nextPage Url to the next page (or null if there is no next page.) String
page The page number. Int
pageSize The number of entries per page. Int
prevPage Url to the previous page (or null if there is no previous page.) String
size Total size of the result set across all pages. Int
sortBy A collection of urls pointing to the results of this search, but with different sorts applied. For more information see SortLink

ListingReservationSummary

Information about a reservation.

Properties

Name Description Type
active Active or Inactive Reservation. Boolean
adults Adult stay count against a reservation. Int
availabilityStatus Represents the Reservation state to control the availability and Calendar view for owner. Owner, Traveler, System can change the availability state of a Reservation. String
checkinTime Checkin Time on 24 hr. scale. If not supplied, system sets the default value of 16 (4:00 PM). String
checkoutTime Checkout Time on 24 hr scale. If not supplied, the system sets the default value of 10 (10:00 AM) String
children Children stay count against a reservation. Int
contact Information about the traveler who is staying. ListingReservationTravelerContact
locale Locale of the Reservation. Defines the locale of Notes, Comments, etc. Defaults to "en_US". String
orders The list of payment orders for the reservation. Order
ownerNote Reservation notes added by owner. In general, represents the owner-traveler conversation. This note is accessible to both owner and traveler. String
ownerOnlyNote Note added by owner against this reservation. Only accessible to owner. String
pets Pets stay count against a reservation. Int
rentalAgreement Rental Agreement document details. RentalAgreement
reservationBranding Branding information associated to Property associated to this Reservation ReservationBranding
reservationCancellation Information about the cancellation of this reservation, if it was cancelled. ReservationCancellation
reservationDates Arrival and Departure Date for this Reservation. No timezone conversion. DateRange
reservationInitialDates The reservation's initial start and end dates DateRange
reservationOriginationDate This is when the reservation was first created. DateTime
reservationPaymentStatus Payment status of this Reservation. Default Value : UNPAID String
reservationReferenceNumber An identifier for this reservation. String
status Represents the transition state of this Reservation. Owner, Traveler, System can change the transition state of a Reservation. Default Value : BUILDING String
travelerNote Note added by Traveler against this Reservation. String

ListingReservationTravelerContact

Information about the Traveler that made a Reservation

Properties

Name Description Type
active Whether this traveler contact information is active or not. Boolean
city The city for the traveler contact. String
companyName The company name for the traveler contact. String
firstName The first name for the traveler contact. String
lastName The last name for the traveler contact. String
state The state for the traveler contact. String

ListingSearchHit

One result in the set of results from a listing search.

Properties

Name Description Type
accommodations The listing's accommodations. String
bathrooms # of bathrooms in the listing. Double
bedrooms # of bedrooms in the listing. Int
bookWithConfidence True if this listing is covered by the HomeAway "Book with confidence" guarantee; false otherwise. Boolean
description A textual description of the property. String
detailsUrl URL to the details about the listing. String
headline Listing headline. String
listingId The ID of the listing. String
listingSource The site this listing was originally created on String
listingUrl Url to view this listing on a HomeAway site. String
location ListingLocation
minStayRange Minimum stay range. MinStayRangeBean
priceQuote PriceQuoteBean
priceRanges Price ranges for the listing. (List) PriceRangeBean
regionPath Path of what regions this listing is in. String
reviewAverage The average rating for the reviews. Double
reviewCount How many reviews exist for this listing. Int
thumbnail Thumbnail of the listing. ImageFileBean

ListingSearchPaginator

A page of results for a listings search.

Properties

Name Description Type
entries The actual results for this page. (List) ListingSearchHit
nextPage URL to the next page or null if none. String
page The page number. Int
pageCount The total number of pages. Int
pageSize The size of the page. Int
prevPage URL to the previous page or null if none. String
refinements A container of links pointing at this search, but refined by each of the possible refinements. (List) ListingSearchRefinement
size Total size of the result set across all pages. Int

ListingSearchRefinement

Properties

Name Description Type
fieldName refinement fieldName String
key refinement key String
options ListingSearchRefinementOption

ListingSearchRefinementOption

A single link pointing at a search, refined by one option.

Properties

Name Description Type
count How many results the refinement will produce. Int
title A title to display for the refinement link. String
url Url to execute the refinement. String

ListingUnit

A single rentable unit of a property.

Properties

Name Description Type
ratePeriods Rate periods for this unit. (List) ListingUnitRatePeriod
reviewSummary Statistical summary of the reviews for this unit. ListingUnitReviewSummary
unitAvailability Data about when a unit is available. ListingUnitAvailability
unitContent UnitContent
unitNumber The unit number of the unit. Int
unitReviewContent A page of reviews for this unit. UnitReviewPaginator

ListingUnitAvailability

Data about when a unit is available.

Properties

Name Description Type
availabilityDefault A single character that represents the availability for days not specified within the dateRange given. Valid characters are: Y=Available, N=Not Available, Q=You must inquire. String
availabilityUpdated Indicates when the unit availability was updated. DateTime
changeOverDefault A single character representing the default changeOver for days not specified within the dateRange given. A changeover day represents a day when a check-in or check-out is allowed to occur, so that owners can e.g. schedule regular cleaning on certain days only. Valid characters are: X=no action possible, C=check-in/out, O=check-out only, I=check-in only String
dateRange The date range that this availability information applies to. After this date range, the property is considered to be whatever the defaults are for this availability. The maximum amount of dateRange days is (3 * 365 + 1) in order to handle 3 years where a leap year is included. DateRange
maxStayDefault The default for the maximum valid stay on days not covered by the dateRange. The time unit of this field is specified by stayIncrementDefault; e.g. if maxStayDefault=3 and stayIncrementDefault=W, the default maximum stay is 3 weeks. Int
minPriorNotifyDefault The default for the minimum number of nights before the check-in that the property owner must be notified for days not covered by the dateRange. For example, minPriorNotifyDefault=1 means that same-day check-in is not available, but check-in could be the next day. A minPriorNotifyDefault of 0 means that there is no prior notification needed. Int
minStayDefault The default for the minimum valid stay on days not covered by the dateRange. The time unit of this field is specified by stayIncrementDefault; e.g. if minStayDefault=3 and stayIncrementDefault=W, the default minimum stay is 3 weeks. Int
stayIncrementDefault A single character that represents the unit of time for the minStayDefault and maxStayDefault. E.g. if minStayDefault=3 and stayIncrementDefault=W, the default minimum stay is 3 weeks. Valid characters are: D=Day, M=Month, W=Week, Y=Year String
unitAvailabilityConfiguration The unit's availability for the specified dateRange. This is a collection of information about availability, where each piece of information is a simple string of comma-separated values or single characters that represent the value for each day in sequence during the dateRange. This is verbose, but is presented in this way to simplify the work needed for app developers when generating a calendar or information about a possible stay. UnitAvailabilityConfiguration

ListingUnitRate

A money amount for a rate. This should always be referenced in combination with the period this rate is for, e.g. WEEKLY, MONTHLY, etc.

Properties

Name Description Type
amount Decimal
currency String

ListingUnitRatePeriod

A set of rates that are effective for a single time period. Having multiple rate periods allows an owner to set different rates for different dates, to accommodate special pricing during e.g. off seasons or special events.

Properties

Name Description Type
dateRange The effective date range for this rate period. DateRange
minimumStay The minimum number of nights' stay for this rate period. Int
name The name of this rate period. String
note A textual note about this rate period. String
rates The rates for this period, which can be many if there are different rates for different durations of stay. This maps rate type to rate, where a rate type is one of extraNight, nightlyWeekday, nightlyWeekend, weekend, weekly, monthly, or season, and the rate is the amount charged for that duration. (Map) String→ListingUnitRate

ListingUnitReview

A review of a unit.

Properties

Name Description Type
arrivalDate Date when the reviewer arrived at the Unit. DateTime
body Textual content of the review. String
headline Textual tag line of the review. String
helpfulCount Number of users that found the review helpful. Int
rating A number from 1-5 that represents the number of stars that the reviewer chose Int
reviewId The Review UUID String
reviewLocale The locale that the review was written in. String
reviewerName Name of the individual renting the unit. String
unhelpfulCount Number of users that found the review unhelpful. Int

ListingUnitReviewSummary

A summary of reviews for this unit.

Properties

Name Description Type
averageRating Average rating of the reviews for a unit, excluding Owner Guestbook reviews (reviews transcribed by the owner from their physical guestbook.) Float
fiveStarReviewCount Total number of five star reviews. Int
fourStarReviewCount Total number of four star reviews. Int
guestbookReviewCount Total number of guestbook reviews, which are reviews that the owner has transcribed from their physical guestbook. Int
oneStarReviewCount Total number of one star reviews. Int
reviewCount Total count of reviews on a unit. Int
threeStarReviewCount Total number of three star reviews. Int
twoStarReviewCount Total number of two star reviews. Int

LocalDate

Properties

Name Description Type

LocationMetaData

MetaData to capture the listingAddress fields we need for search

Properties

Name Description Type
additionalAddressLine1 An additional line of address data. This is to support international addresses such as: Yamacraw Hill Road -- addressLine1 Sunrise Acres -- addressLine2 PO Box EE 16723 -- additionalAddressLine1 Nassau, New Providence 00000 -- addressLine3, addressLine4 postalCode BS -- countryCode String
addressIsValid Boolean
addressLine1 Line one of street address data. String
addressLine2 Line two of street address data. String
addressLine3 Line three of street address data. for US addresses, this is where you should put "city". String
addressLine4 Line four of street address data. for US addresses, this is where you should put "state". String
addressLine5 Line five of street address data. for US addresses, this is where you should put "county". String
country The country in which the address is located. String
displayLatitude Decimal
displayLongitude Decimal
postalCode The postal code of the address. String

MessageAttachment

A file attachment on a conversation message.

Properties

Name Description Type
binaryUrl Absolute url to the actual attachment file. String
isTransient True if this file is going to eventually be deleted by an automatic cleanup job. Non-transient attachments can still be manually deleted by their owners, so this flag being false does not guarantee that the file will always exist. When an attachment is deleted the binary file goes away, but this container of metadata including the filename will still exist. Boolean
name The human-readable filename of this attachment, e.g. "living_room.jpg". String
status Attachment status, which is one of AVAILABLE, DELETED, PENDING, SCANNING, REJECTED. You will only have access to the file if the status is AVAILABLE. String

MessageAttribute

An additional attribute not covered by the base message model.

Properties

Name Description Type
key Attribute key String
value Attribute value String

MinStayRangeBean

Properties

Name Description Type
minStayHigh Int
minStayLow Int

Money

Represents an amount of money.

Properties

Name Description Type
The amount of money, in the provided currency. Decimal
currency ISO currency code. String

Note

Properties

Name Description Type
texts The list of variant of this text, by Locale. Text

Occupancy

Represents the occupancy for a stay, consisting of a number of adults and children.

Properties

Name Description Type
adultCount The number of adults for the stay Int
childCount The number of children for the stay Int

Order

Properties

Name Description Type
bodyText Body text against this reservations Order. String
currency Currency for this reservations order. String
externalId Reference Id in external system. SOR information for external system. Can be used for searching. String
orderItems A List of the order line items OrderItem
paymentSchedule Holds Payment Schedule information associated to this Order. ReservationPaymentSchedule
rawReservationOrderGuid raw GUID to identify the order. String
reservationCancellationPolicy Holds Cancellation Policy information associated to this Order. CancellationPolicy
reservationOrderState Reservation Order state. String
stayFees list of Stay Fees associated with this order. These fees do not affect any calculations of order values and are purely information to the traveler about what fees will be paid during the stay at the property to local representatives. ReservationOrderStayFee

OrderItem

Properties

Name Description Type
description Description of the Order Line Item. String
externalId ExternalID for the line item String
feeType Type of Order Line Item. String
name Name of Order Line Item. String
preTaxAmount Amount without Tax. Money
productConstant The product grouping of this ReservationOrderItem String
quoteItemType This is a combination of the QuoteItemType from ecom-quotes and ReservationFeeType as used by api-haconnect String
status Status of this Order Line Item String
taxRate Tax in Rate applied to this Order Line Item Amount. Decimal
totalAmount Total Amount including Tax. Money

OwnerListingPaginator

A page of results for a listing search.

Properties

Name Description Type
entries The actual results on this page. (List) OwnerListingSummary
filters A collection of urls pointing to the results of this search, but with different filters applied. For more information see Filter
nextPage Url to the next page (or null if there is no next page.) String
page The page number. Int
pageSize The number of entries per page. Int
prevPage Url to the previous page (or null if there is no previous page.) String
size Total size of the result set across all pages. Int
sortBy A collection of urls pointing to the results of this search, but with different sorts applied. For more information see SortLink

OwnerListingSummary

Information about a listing.

Properties

Name Description Type
currency The chosen currency for the current listing subscription. String
externalId For Listings that are imported from an external system, this field can contain the unique identifier for the Listing within that system. String
firstLive When the listing first went live. DateTime
lastUpdated When the listing was last updated. DateTime
listingId The id of the listing. String
listingUrl A link to the live property page on the HomeAway website. String
location The location information for this listing, including the address and lat-long coordinates. LocationMetaData
productType The type of product that this listing has (subscription/ppb). String
propertyName Name of the property. String
sourceSite The HomeAway site this listing was created on. String
status The status of the listing (ENABLED/DISABLED). String
subscriptionCanceledDate The date the last subscription was canceled. DateTime
subscriptionEndDate The end date of the current subscription for this listing. DateTime
subscriptionStartDate The start date of the current subscription for this listing. DateTime
tierCode The tier (if any) this listing has. String
units A list of the units advertised by the listing. UnitSummary

Payment

A single scheduled payment on a quote. (A quote may have several scheduled payments.)

Properties

Name Description Type
amount Payment amount Money
dueDate The date this payment is due. DateTime
includes Fees included on this payment. Fee

PaymentLineItem

Properties

Name Description Type
active Boolean indicating whether the payment line item is active (and not soft deleted) Boolean
amount The amount of the line item (the currency is implied from the currency of the payment schedule that this payment line item belongs to) Decimal
description String
paymentDate The date this line item was paid DateTime
paymentTransactionItemGuid GUID for a PaymentTransactionItem (currently these entities are not exposed in Core API) String
status Status of the Payment Line Item String
type The type of line item String

PaymentScheduleItem

Properties

Name Description Type
amount Payment Amount requested against this payment schedule item. Money
description Textual Description for Payment Schedules. String
dueDate Due date of the Payment Schedule. DateTime
externalId Reference Id in external system. SOR information for external system. Can be used for searching. String
paymentLineItems PaymentLineItem
refundDescription Refund description of Payment Schedule Item. String
refundPercent Percent of amount can be refunded against this Payment schedule Item. If the refundable is 'TRUE' the refundPercent should be supplied. Decimal
refundable Is this Payment Schedule refundable? By default it will be set to 'FALSE'. If it is set to 'TRUE' then the refundDescription and refundPercent should be supplied. Boolean
status Status of the Payment Schedule Item, include key states like SCHEDULED, PAID and REFUNDED String

Phone

Phone number information

Properties

Name Description Type
areaCode String
countryCode String
ext String
number String

PhotoImage

A single image, used as a component of which contains several PhotoImages of the same photo in different sizes.

Properties

Name Description Type
dimension The height and width of the image. Dimension
uri The URI to access the image. String

PriceQuoteBean

Properties

Name Description Type
amount Double
averageNightly Double
currencyUnits String
fees Double
other Double
rent Double
tax Double

QuoteDetails

Details of a quote.

Properties

Name Description Type
bookingUrl A url to the page on a HomeAway site where the traveler can book the stay described in this quote. String
checkinDate The check-in date for the stay. DateTime
checkoutDate The check out date for the stay. DateTime
currencyCode The currency that amounts in this quote are in. String
fees A list of fees on this quote. Fee
listingId The listing for the unit that this quote is for. String
occupancy Counts of adults and children. Occupancy
payments Scheduled payments on this quote. Payment
quoteTotals A container of the overall quote total as well as various subtotals. QuoteTotals
unitId The unit that this quote is for. String

QuoteTotals

The overall total amount due for this quote, as well as some relevant subtotals.

Properties

Name Description Type
ownerAmount Amount due to owner. Money
subtotal The total quote amount, minus any refundable deposits. Money
total Total quote amount. Money
totalTax Total tax amount. TaxTotals

RateAttributes

Properties

Name Description Type
displayFullQuote Boolean
noMandatoryFees Boolean

RatePlanCancellationPolicy

A cancellation policy for booked stays.

Properties

Name Description Type
active Is this cancellation policy active? Boolean
cancellationPolicyText The text displayed to the traveler that outline the terms of the cancellation policy. String
minDaysCancellable The number of days prior to arrival when cancellations are allowed. Int
refundPercent The percent of money refunded if a stay is cancelled. Decimal

RatePlanDetails

Details of a rate plan.

Properties

Name Description Type
rateAggregations The list of rate aggregations, which is a container that aggregates the various rate details that make up the final rate table for a unit. (List) RateAggregation
rateAttributes Additional attributes for this rate plan. RateAttributes

RatePlanStayTax

Contains either a tax rate or amount that is either charged once, or on a per night, per guest basis. This type of specialized tax is only applicable to properties in the EU. When computing the total stay tax amount, products (such as property damage protection, carefree rental guarantee, etc.) should be ignored.

Properties

Name Description Type
amount The tax amount to charge per night, per guest. If an amount is specified, the rate must be null. Decimal
calculationType String describing how Stay Tax should be figured into rate calculations. String
currency ISO currency code. String
minimumAge Integer specifying the minimum age at which stay tax should be charged. Int
rate The tax rate. If a rate is specified, the amount must be null. Decimal

RentalAgreement

Agreement against given Reservation.

Properties

Name Description Type
accepted Is this rental agreement accepted? Boolean
agreementText Rental agreement text against this reservations. String
externalId External System reference to the information. String
url URL to the Rental agreement uploaded/stored document. String

ReservationBranding

Property Brand details associated to this property.

Properties

Name Description Type
companyName Name a branding company. String
companyUrl Site Url of a branding company. String
logoUrl Logo URL of a branding company. String
operationHours Operation Hour description of Integrated Property Managers associated to this Brand. String
showGuestOwnerEmail Sets the privacy policy for emails. Default Value : True. Boolean

ReservationCancellation

ReservationCancellation details for this reservations.

Properties

Name Description Type
cancellationExecutionType String
cancellationSource String
date Date on which the Reservation was cancelled. DateTime
note ReservationCancellation Notes. String
reason ReservationCancellation reason category. String

ReservationOrderStayFee

A Reservation Order Stay Fee represents miscellaneous fees that will be required of the traveler during their actual stay at the property. These fees can be as varied as daily cash only payments of electricity usage to stay begin/end local resort or city taxes that must be paid in person. This showed up first as a result of integrations with Interhome.

Properties

Name Description Type
description Description of the stay fee. String

ReservationPaymentSchedule

Properties

Name Description Type
acceptedPaymentForms List of accepted payment descriptors. Refer . Ex. (List)
description Textual Description for Payment Schedules. String
name Name of Payment Schedule. String
paymentScheduleItems Hydrated list of Payment Schedule Items. Used during bulk sync and /hydrated retrieval PaymentScheduleItem

Tax

A tax amount and metadata about the tax.

Properties

Name Description Type

TaxTotals

The total amount of tax and how it was calculated.

Properties

Name Description Type
taxAmount The amount of tax. Money
taxCalculation How this tax amount was calculated. Can be one of FLAT_AMOUNT (the tax is charged as a flat amount of money, as opposed to a percent); INCLUDED (the tax is included in the price of the rental); NONE (no tax); or PERCENTAGE_BASED (the tax is a percentage of the rental amount). String

Text

A piece of localized text.

Properties

Name Description Type
content The string content of the text. String
locale The locale that this text is in. String

UnitAvailabilityConfiguration

The UnitAvailability configuration.

Properties

Name Description Type
availability A letter code for every day of the range. Y=Available, N=Not Available,Q=Inquiry Only or N for OLB purposes. A maximum of 3 years of availability can be given (3*365 + 1 days). There cannot be more days given than there are days in the dateRange. An example: YYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQYYYNNNQQ... String
availableUnitCount OPTIONAL: For multi-unit availability. This is a comma separated list of the number of units available for each day in the given date range. In this case 3 years (3*365 + 1) numbers. For example: 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,... The TextLength max is 4,383 because if each stay is 3 digits (999 for example), and there are 3 years worth, then there would be 999,999,...,999 which would be a total of 4,383 characters. String
changeOver A letter code for every day of the range. X=no action possible, C=check-in/out, O=check-out only, I=check-in only. A maximum of 3 years of availability can be given (3*365 + 1 days). There cannot be more days given than there are days in the dateRange. An example: CCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOXCCIIOOX... String
maxStay The maximum stay CSV of 0->999, 0 == "no max stay". One comma separated number for every day of the range. In this case 3 years (3*365 + 1) numbers. For example: 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,... The TextLength max is 4,383 because if each stay is 3 digits (999 for example), and there are 3 years worth, then there would be 999,999,...,999 which would be a total of 4,383 characters. String
minPriorNotify Min prior notification: 0->999, 0 == "no min prior notification". One comma separated number for every day of the range. In this case 3 years (3*365 + 1) numbers. For example: 2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,... The TextLength max is 4,383 because if each stay is 3 digits (999 for example), and there are 3 years worth, then there would be 999,999,...,999 which would be a total of 4,383 characters. String
minStay The minimum stay CSV of 0->999, 0 == "no min stay". One comma separated number for every day of the range. In this case 3 years (3*365 + 1) numbers. For example: 2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,2,2,3,7,7,7,7,... The TextLength max is 4,383 because if each stay is 3 digits (999 for example), and there are 3 years worth, then there would be 999,999,...,999 which would be a total of 4,383 characters. String
stayIncrement What the increment of stay (min/max) is. D=Day, M=Month, W=Week, Y=Year When D, M, W, Y: stay must be in increments of min-stay * increment length Example: minStay = 3, stayIncrement of W means that the min stay is 3 weeks and can increment by 1 week. Example: minStay = 2, stayIncrement of D means that the min stay is 2 Days and can increment by any amount of days, up to max, after that. One letter for every day of the range. In this case 3 years (3*365 + 1) letters. For example: DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD... String

UnitContent

Information about a unit.

Properties

Name Description Type
area The usable area of the unit. Int
areaUnit The unit measure in which the unit's area is expressed. String
bathroomDetails Textual details describing the bathroom(s) in the unit. String
bathrooms Structured Room data about the bathroom(s) in the unit. ListingAdRoom
bedroomDetails Textual details describing the bedroom(s) in the unit. String
bedrooms Structured Room data about the bedrooms(s) in the unit. ListingAdRoom
diningSeating The number of people who can be seated for dining in the unit. Int
features A list of structured data about some aspect of this unit. Features include information about the home and its rooms, amenities, nearby attractions, etc. ListingAdFeature
maxSleep The maximum number of people who can be lodged in the unit. Int
maxSleepInBeds The maximum number of people who can be lodged, in beds, in the unit. Int
numberOfBathrooms The number of bathrooms in the unit. Decimal
numberOfBedrooms The number of bedrooms in the unit. Decimal
propertyType The non localized type of property this unit represents. String

UnitReviewPaginator

A page of results for a search of unit reviews.

Properties

Name Description Type
unitReviews The actual set of results on this page. (List)
nextPage Url to the next page, or null if there is no next page. String
page the page number. Int
pageSize The number of entries per page. Int
prevPage Url to the previous page, or null if there is no previous page. String
size The total size of results across all pages. Int

UnitSummary

A UnitSummary is a consolidation of different data pieces related with a Unit. This is used ONLY for view-summaries endpoint.

Properties

Name Description Type
availabilityUpdated When was the unit's availability was last updated DateTime
externalId For Units from an external system, this field can contain the unique identifier for the unit. String
name The name of the unit String
status The Status information pertaining to the unit: PENDING, ENABLED, ARCHIVED String
unitNumber The unit number of the unit. See Also: Int

User

Properties

Name Description Type
accounts UserAccount
emailAddress String
firstName String
id String
lastName String
phones Phone

UserAccount

Properties

Name Description Type
accountType The account type AccountType
active Boolean
advertiser Contains the advertiser information for any listings owned by this account AdvertiserInfo