Skip to main content
GET
Retrieve invoices

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

companyRef
string<uuid>
deprecated

Deprecated. Use customerRef instead. UUID of the company whose invoices to list.

createDate[gte]
string

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

createDate[lte]
string

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

customerRef
string<uuid>

UUID of the customer whose invoices to list.

issueDate[gte]
string

Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range.

issueDate[lte]
string

Filter invoices issued on or before this date (ISO 8601). Use with issueDate[gte] for a range.

limit
integer

Maximum number of invoices 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 invoices to list.

membershipRef
string<uuid>
deprecated

Deprecated. Use customerRef instead. UUID of the membership whose invoices to list.

nextPageToken
string

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

q
string

Case-insensitive search by invoice code or number. Requires customerRef or locationRef.

status
string

Filter by invoice status. 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

Response

OK

invoices
object[]
required

List of invoices.

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.