Quote data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNounique identifier for the quote
created_atstring (date-time)Nowhen the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstringNopointer to the Property Listing to price
unittype_idstringNopointer to the Property Unittype (room type) to price
start_atstring (date-time)Nothe arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)Nothe departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
guestsnumberNototal number of guests
adultsnumberNonumber of adults
childrennumberNonumber of children
promotion_codestringNopromotion or coupon code to apply
currencystringNoISO 4217 currency code
total_amountnumberNothe total price of the stay
deposit_amountnumberNothe deposit due at booking
line_itemsPropertyLineitem[]Noprice breakdown (base price, fees, taxes, discounts)
line_items[].typeenumNobase price, fee, tax, discount or deposit Values: BASE, FEE, TAX, DISCOUNT, DEPOSIT, OTHER
line_items[].namestringNothe line item name, eg. Cleaning fee
line_items[].descriptionstringNofree-text description of the line item
line_items[].amountnumberNothe line item amount (discounts are negative)
line_items[].is_mandatorybooleanNowhether the line item is mandatory

TypeScript

TypeScript
export type PropertyQuote = {
	id?: string; // unique identifier for the quote
	created_at?: string-time; // when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	listing_id?: string; // pointer to the Property Listing to price
	unittype_id?: string; // pointer to the Property Unittype (room type) to price
	start_at?: string-time; // the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	guests?: number; // total number of guests
	adults?: number; // number of adults
	children?: number; // number of children
	promotion_code?: string; // promotion or coupon code to apply
	currency?: string; // ISO 4217 currency code
	total_amount?: number; // the total price of the stay
	deposit_amount?: number; // the deposit due at booking
	line_items?: []; // price breakdown (base price, fees, taxes, discounts)
	raw?: any; // raw data from the integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodPropertyQuote = z.object({
	id: z.string().optional().describe("unique identifier for the quote"),
	created_at: z.string-time().optional().describe("when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	listing_id: z.string().optional().describe("pointer to the Property Listing to price"),
	unittype_id: z.string().optional().describe("pointer to the Property Unittype (room type) to price"),
	start_at: z.string-time().optional().describe("the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	guests: z.number().optional().describe("total number of guests"),
	adults: z.number().optional().describe("number of adults"),
	children: z.number().optional().describe("number of children"),
	promotion_code: z.string().optional().describe("promotion or coupon code to apply"),
	currency: z.string().optional().describe("ISO 4217 currency code"),
	total_amount: z.number().optional().describe("the total price of the stay"),
	deposit_amount: z.number().optional().describe("the deposit due at booking"),
	line_items: z.array().optional().describe("price breakdown (base price, fees, taxes, discounts)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyQuote:
	"""unique identifier for the quote"""
	id: Optional[str]
	"""when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""pointer to the Property Listing to price"""
	listing_id: Optional[str]
	"""pointer to the Property Unittype (room type) to price"""
	unittype_id: Optional[str]
	"""the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""total number of guests"""
	guests: Optional[int]
	"""number of adults"""
	adults: Optional[int]
	"""number of children"""
	children: Optional[int]
	"""promotion or coupon code to apply"""
	promotion_code: Optional[str]
	"""ISO 4217 currency code"""
	currency: Optional[str]
	"""the total price of the stay"""
	total_amount: Optional[int]
	"""the deposit due at booking"""
	deposit_amount: Optional[int]
	"""price breakdown (base price, fees, taxes, discounts)"""
	line_items: Optional[PropertyPropertyQuoteLine_items]
Are we missing anything? Let us know
Was this page helpful?