Skip to main content
GET
/
api
/
public
/
billing
/
invoices
/
{invoiceId}
/
attendees
/
{attendeeUniqueId}
{
  "CalendarEventId": 123,
  "EventProductId": 123,
  "FullName": "<string>",
  "Email": "<string>",
  "CalendarEventName": "<string>",
  "EventProductName": "<string>",
  "EventProductPrice": "<string>",
  "EventProductCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": "<string>",
  "UniqueId": "<string>",
  "401 Unauthorized": {},
  "404 Not Found": {}
}

​
Get Invoice Event Attendee Line

Returns the EventAttendee record linked to a specific invoice line. This endpoint is used to enrich invoice lines that originate from an event ticket purchase, providing event name, product pricing, and attendee details.

​
Authentication

This endpoint requires an authenticated customer session.

​
Path Parameters

​
invoiceId
number
required
The unique identifier of the parent invoice.
​
attendeeUniqueId
string
required
The UniqueId of the event attendee record associated with the invoice line. Available on the invoice line as EventAttendeeUniqueId.

​
Query Parameters

​
_shape
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=Attendee.FullName,Attendee.EventProductName,Attendee.CalendarEvent.Name.

​
Response

Returns an EventAttendee object.
​
CalendarEventId
number
ID of the calendar event the attendee signed up for.
​
EventProductId
number
ID of the event product (ticket type) purchased.
​
FullName
string
Full name of the attendee.
​
Email
string
Email address of the attendee.
​
CalendarEventName
string
Display name of the event.
​
EventProductName
string
Name of the ticket type or event product purchased.
​
EventProductPrice
string
Price of the event product as a formatted string.
​
EventProductCurrencyCode
string
ISO 4217 currency code for the event product price.
​
CoworkerId
number
ID of the customer who purchased the ticket (if applicable).
​
CoworkerFullName
string
Full name of the customer (if applicable).
​
CoworkerInvoiceNumber
string
Invoice number associated with the purchase (if applicable).
​
CoworkerInvoicePaid
string
Whether the associated invoice has been paid (if applicable).
​
UniqueId
string
Globally unique identifier for the attendee record.

​
Example Response

{
  "CalendarEventId": 201,
  "EventProductId": 55,
  "FullName": "Jane Smith",
  "Email": "jane.smith@example.com",
  "CalendarEventName": "Monthly Networking Meetup",
  "EventProductName": "General Admission",
  "EventProductPrice": "$25.00",
  "EventProductCurrencyCode": "USD",
  "CoworkerId": 987,
  "CoworkerFullName": "Jane Smith",
  "CoworkerInvoiceNumber": "INV-2025-000124",
  "CoworkerInvoicePaid": "false",
  "UniqueId": "f1e2d3c4-b5a6-7890-cdef-1234567890ab"
}

​
Usage in Portal

Used to render event/ticket details in invoice line rows within the basket and invoice summary.
  • File: src/components/Basket/invoiceLines/EventAttendeeInvoiceLineRow.tsx

​
Typical integration pattern

// From src/api/endpoints.ts
// endpoints.billing.invoices.attendee = (invoiceId: number, attendeeUniqueId: string) => ({
//   url: `/api/public/billing/invoices/${invoiceId}/attendees/${attendeeUniqueId}`,
//   type: null as unknown as EventAttendee,
// })

// Usage in React
const endpoint = endpoints.billing.invoices.attendee(invoice.Id, line.EventAttendeeUniqueId)
const { resource: attendee } = useData<typeof endpoint.type>(httpClient, endpoint.url)
  • GET /api/public/billing/invoices/{invoiceId} – Get full invoice details
  • GET /api/public/events/{id} – Get event details

​
Error Responses

​
401 Unauthorized
error
The current user is not authenticated or does not have access to this invoice.
​
404 Not Found
error
The invoice or attendee record does not exist.