Document package booking

A package booking on a document template booking. Access via booking.package_bookings. Line items are grouped visible sub-items within the package, optionally grouped further when the package is custom priced or hides its element prices behind the package total.

Properties

formatted_discount

Total price reduction on the package booking, formatted for display.

Returns: String — e.g. -$25.00 when a discount applies.

formatted_total

Package booking total, formatted for display in the booking currency.

Returns: String — e.g. $200.00.

line_items

Visible, grouped sub-items within the package booking.

Returns: Array (Document::BookingItemDrop)

package_name

The name of the booked package.

Returns: String

show_element_prices?

Whether the grouped line items carry their own price. When true, the package row leaves its price out.

Returns: Boolean — true when the package shows its element prices.

show_grouped?

Whether to render the package as a grouped entity in the document. When false, show the line items as a flat list with no package grouping.

Returns: Boolean — true unless the package shows its elements only.

start_on

The earliest start date across the package booking sub-items.

Returns: Date or nil — nil when no sub-items have a start date.