bookings
Booking records for the client’s workspace. Demo/test excluded unless configured otherwise.
| Column | Description |
|---|---|
id |
Unique identifier for the booking |
created_at |
The UTC date, including time, when this booking was created |
updated_at |
The UTC date, including time, when this booking was updated |
external_booking_id |
The unique code for this booking from an external source |
status |
An enum, available options: canceled, failed, success, due… |
confirmation_code |
The confirmation code for this booking |
platform |
The platform where this booking originated |
check_in |
The check-in date for this booking |
check_out |
The check-out date for this booking |
guests_count |
The number of guests for the booking |
lead_guest_name |
The name of the main guest. Likely their account name |
lead_guest_avatar |
The avatar for the lead guest provided by platforms |
lead_guest_home_town |
The hometown of the lead guest |
platform_fee_gbp |
The price charged by the platform for this booking |
cleaning_fee_gbp |
The cleaning fee price for this booking |
other_fees_gbp |
Any other fees for this booking |
accommodation_total_price_gbp |
Total price for booking |
owner_payout |
DEPRECATED |
cancellation_policy |
DEPRECATED |
versions |
DEPRECATED |
confirmed_at |
The UTC date, including time, when this booking was confirmed |
imported_at |
The UTC date, including time, when this booking was imported |
financial_status |
An enum showing the status of payment |
external_listing_id |
A unique code for the listing that created this booking - from external channels |
external_guest_id |
The guest ID from external sources (Airbnb only) |
instant_book |
DEPRECATED |
closed_at |
DEPRECATED |
last_updated_at |
The UTC date, including time, when this booking was updated |
nights_count |
The number of nights for this booking |
days_in_advance |
DEPRECATED |
financial_errors |
Array with errors from generating booking financials |
rating |
DEPRECATED |
property_id |
The ID of the unit this booking is for |
lead_guest_phone |
The phone number of the main guest |
new_booking_confirmation_sent |
Boolean to indicate if a new booking confirmation has been sent |
canceled_booking_confirmation_sent |
Boolean to indicate if a cancelled booking confirmation message has been sent |
platform_edited |
True if this booking has been edited on the platform |
created_for_test |
DEPRECATED |
generate_financials_halt_reason |
The reason why the booking financial generator stopped |
generate_transactions_halt_reason |
The reason why the booking daily revenue generator stopped |
vetting_status |
Guest vetting status |
guest_id |
The ID of the guest |
notes |
Any internal notes about the booking |
pre_approve_state |
DEPRECATED |
conversation_id |
The ID of the conversation this booking relates to |
lead_guest_email |
The email address of the lead guest |
total_paid |
DEPRECATED |
balance_due |
The amount still owed for this booking |
external_inquiry_id |
The lead ID from external sources |
discount |
The amount of discount, in monetary terms, applied to this booking |
additional_charges_total_price_gbp |
Total charges for booking |
requested_booking_confirmation_sent |
A boolean indicating if a requested booking confirmation has been sent |
platform_adaptor |
An enum containing the platform adapter used to process this booking |
code |
Similar to UUID - comes from DBW (Hanami) and used for inbound emails |
local_direct_booking |
DEPRECATED |
uuid |
A unique ID for this booking |
booking_source_id |
The ID of the source of this booking |
new_inquiry_notification_sent |
True if we have sent the new lead notification and false if we haven’t |
additional_fees |
Additional fees in JSON format |
security_deposit_fee |
The security deposit fee for the booking |
children |
The number of children for the booking |
multi_unit_group_id |
The unit type ID for this booking |
imported_via_dev_api |
True if this booking was imported via the dev API |
messaging_mode |
relay_via_webhook, direct_to_guest, or relay_via_external_platform |
extra_information |
HTML showing additional information for this booking |
external_group_booking_id |
The group booking ID from external sources |
keycafe_key_id |
DEPRECATED |
rate_plan_id |
The rate plan ID for this booking |
original_platform |
The platform where this booking originated |
platform_currency_code |
The currency code for this booking on the platform level |
cancellation_policy_id |
The ID to the cancellation policy |
cancellation_fee |
The fee charged for cancelling this booking |
planned_arrival |
The date the guests will arrive for this booking |
planned_departure |
The date the guests will depart for this booking |
arrived_at |
Date when the guest arrived |
departed_at |
The UTC date, including time, when this guest departed |
canceled_at |
The UTC date, including time, when this booking was cancelled |
listing_id |
The ID of this listing |
booking_context_id |
The ID of the booking context |
turnover_days |
Turnover days at the booking level (the amount configured in the booking policy at the moment the booking was made) |
payment_charge |
This value comes from BDC - when ReservationsAPI Payment Charges is enabled |
offer_unique_reference |
The unique reference for an offer for this booking |
inquiry_unique_reference |
A unique ID for the lead to this booking |
tmp_offer_booking_rate |
A JSON with rate interval and also rate amount in cents |
external_account_id |
DEPRECATED |
product_id |
The ID of the Sales Proposition product linked to this booking |
timestamp |
Date when the table was last synchronized |