Document booking
A customer booking in a document template.
A customer booking in a document template. Available as booking in document templates and emails.
Properties
billing_address
The booking's billing address.
Returns: Document::AddressDrop
booked_date
Date the booking was completed, localised for display.
Returns: String or nil — nil when the booking has not been booked.
exclusive_tax_rates
Exclusive tax rates applied to this booking, deduplicated by rate. Each
entry has tax_name, name, and formatted_total properties.
Returns: Array
formatted_balance
Outstanding balance on the booking, formatted for display.
Returns: String
formatted_subtotal
Booking subtotal before adjustments, formatted for display.
Returns: String
formatted_total
Total booking amount, formatted for display in the booking currency.
Returns: String — e.g. $460.00.
formatted_total_before_adjustments
Booking total before adjustments such as gratuity, formatted for display.
Returns: String
formatted_total_gratuity_adjustments
Total gratuity on the booking, formatted for display.
Returns: String
formatted_total_payments
Total payments received for the booking, formatted for display.
Returns: String
has_gratuity?
Whether the booking includes a gratuity adjustment.
Returns: Boolean
inclusive_tax_rates
Inclusive tax rates applied to this booking, deduplicated by rate. Each
entry has tax_name, name, and formatted_total properties.
Returns: Array
line_items
Visible, totalable line items that are not part of a package booking, grouped where appropriate.
Returns: Array (Document::BookingItemDrop)
package_bookings
Active package bookings on this booking's order.
Returns: Array (Document::PackageBookingDrop)
reference
The booking reference shown to the customer.
Returns: String
start_date
Earliest start date across the booking's line items, localised for display.
Returns: String or nil — nil when the booking has no start date.