Skip to main content
List credit notes that may answer a claim

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields of each row; use dots for nested fields, such as supplier.id. Fields: credit_note_id, credit_note_number, issued_date, amount, remaining_amount, currency_code, supplier, prefill, claim_alerts, link, group, check_reason, claim_invoice_number.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096

Only notes with this link. Without it, notes matched to a claim invoice come first.

Available options:
claim_invoice,
none

Response

A page of credit notes.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required
counts
object
required

All suggestions by link, whatever the page, cursor or link filter.