Reservation data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the reservation |
created_at | string (date-time) | No | when the reservation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the reservation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing that is booked |
unittype_ids | string[] | No | Property Unittypes (room types) that are booked |
guest_id | string | No | pointer to the Property Guest who made the reservation |
guest_name | string | No | the primary guest full name |
guest_email | string | No | the primary guest email address |
guest_phone | string | No | the primary guest telephone number |
status | enum | No | the reservation status Values: INQUIRY, PENDING, CONFIRMED, CANCELLED, CHECKED_IN, CHECKED_OUT, NO_SHOW, OTHER |
source | string | No | the booking channel, eg. Airbnb, Booking.com or direct |
confirmation_code | string | No | the booking channel confirmation code |
start_at | string (date-time) | No | the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
estimated_arrival_time | string | No | the guest estimated arrival time (HH:mm, local time) |
estimated_departure_time | string | No | the guest estimated departure time (HH:mm, local time) |
nights | number | No | number of nights |
guests | number | No | total number of guests |
adults | number | No | number of adults |
children | number | No | number of children |
infants | number | No | number of infants |
pets | number | No | number of pets |
currency | string | No | ISO 4217 currency code |
total_amount | number | No | the total price of the reservation |
paid_amount | number | No | the amount already paid |
balance_amount | number | No | the remaining balance |
line_items | PropertyLineitem[] | No | price breakdown (base price, fees, taxes, discounts) |
line_items[].type | enum | No | base price, fee, tax, discount or deposit Values: BASE, FEE, TAX, DISCOUNT, DEPOSIT, OTHER |
line_items[].name | string | No | the line item name, eg. Cleaning fee |
line_items[].description | string | No | free-text description of the line item |
line_items[].amount | number | No | the line item amount (discounts are negative) |
line_items[].is_mandatory | boolean | No | whether the line item is mandatory |
notes | string | No | free-text notes about the reservation |
cancelled_at | string (date-time) | No | when the reservation was cancelled (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
web_url | string | No | the reservation URL |
metadata | PropertyMetadata[] | No | custom field values |
metadata[].id | string | No | the custom field identifier |
metadata[].slug | string | No | the custom field key |
metadata[].value | object | No | the custom field value |
metadata[].namespace | string | No | the scope or origin of the custom field |
metadata[].format | enum | No | the data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | additional data about the custom field |
Are we missing anything? Let us know
Was this page helpful?