Skip to main content
GET
List invoice items

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gte]
string

Filter invoice items created on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

Filter invoice items created on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef
string<uuid>

UUID of the customer whose invoice items to list.

issueDate[gte]
string

Filter invoice items on invoices issued on or after this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[lte] for a range.

issueDate[lte]
string

Filter invoice items on invoices issued on or before this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[gte] for a range.

limit
integer

Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose invoice items to list.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

status
string

Filter by the status of the invoice the item is on. Items not on an invoice are excluded. Comma-separated values, e.g. draft,issued.

Supported values:

  • draft — created but not sent
  • issued — sent to the customer but unpaid
  • paid — fully paid
  • voided — cancelled and no longer valid
invoiceRef
string<uuid>

UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply.

pending
enum<string>

Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false.

Available options:
true,
false
type
string

Filter by invoice item type. Comma-separated values, e.g. custom,order.

Response

OK

invoiceItems
object[]
required

List of invoice items.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.