Skip to main content
GET
Retrieve credit notes

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 credit notes created on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

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

invoiceRef
string<uuid>

UUID of the invoice whose credit notes to list.

limit
integer

Maximum number of credit notes 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 credit notes 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 credit note status. Comma-separated values, e.g. issued,voided.

Supported values:

  • issued — active credit note
  • voided — cancelled and no longer valid

Response

OK

creditNotes
object[]
required

List of credit notes.

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.