Skip to main content
GET
Get Invoice Booking Line

Get Invoice Booking Line

Returns the Booking record linked to a specific invoice line. This endpoint is used to enrich invoice line items that originate from a booking, giving the UI access to full booking details (resource name, times, floor plan, etc.) alongside the invoice.

Authentication

This endpoint requires an authenticated customer session.

Path Parameters

number
required
The unique identifier of the parent invoice.
string
required
The UniqueId of the booking associated with the invoice line. This value is available on the invoice line object as BookingUniqueId.

Query Parameters

string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Booking.ResourceName,Booking.FromTime,Booking.ToTime.

Response

Returns a Booking object.
number
Unique identifier of the booking.
string
Globally unique identifier of the booking.
number
ID of the booked resource.
string
Display name of the booked resource.
string
ISO 8601 datetime for the start of the booking.
string
ISO 8601 datetime for the end of the booking.
number
ID of the customer who made the booking.
number
ID of the associated invoice.
boolean
Whether the booking is still tentative/unconfirmed.
boolean
Whether the booking has been cancelled.

Example Response

Usage in Portal

This endpoint is used to render booking-specific details within an invoice line row in the basket/invoice summary UI.
  • File: src/components/Basket/invoiceLines/BookingInvoiceLineRow.tsx

Typical integration pattern

  • GET /api/public/billing/invoices/{invoiceId} – Get full invoice details
  • GET /api/public/bookings/{id} – Get booking details directly

Error Responses

error
The current user is not authenticated or does not have access to this invoice.
error
The invoice or booking does not exist or cannot be associated.