Document booking item

A grouped booking line item in a document template. Each item represents one or more matching finance line items rolled up with a quantity. Access via booking.line_items or package_booking.line_items.

Properties

duration

The duration of the line item. Uses a custom duration when set; otherwise falls back to the slot duration.

Returns: Integer or nil

duration_unit

The unit for duration: day, hour, or min.

Returns: String or nil

end_on

The end date of the line item.

Returns: Date or nil — nil when the item has no end date.

end_time_in_zone

The end time in the product timezone.

Returns: Time or nil — nil when the item has no end time.

formatted_discount

Total price reduction on the grouped line item, formatted for display.

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

formatted_total

Grouped line item total, formatted for display in the booking currency.

Returns: String — e.g. $300.00.

has_start_time?

Whether the line item has a start time.

Returns: Boolean

product_name

The name of the booked product.

Returns: String

quantity

The number of matching line items in this group.

Returns: Integer

start_on

The start date of the line item.

Returns: Date or nil — nil when the item has no start date.

start_time_in_zone

The start time in the product timezone.

Returns: Time or nil — nil when the item has no start time.

total_guests

The total guest count across all grouped line items.

Returns: Integer

variant_name

The name of the booked variant.

Returns: String

variant_requires_adult_count?

Whether the variant uses per-unit pricing that requires an adult count.

Returns: Boolean