Skip to main content
GET
List an entity's credit notes

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

entityId
string<uuid>
required

Query Parameters

id[lt]
string

Collection cursor pointer to the next page

id[gt]
string

Collection cursor pointer to the previous page

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000

Response

Invoice credit notes collection response

@context
string
default:/contexts/InvoiceCreditNote
@id
string
default:/invoices/credit-notes
@type
string
default:hydra:Collection
hydra:member
object[]
hydra:view
object

Pagination information