Skip to main content
Get a claim credit note

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
credit_note_id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as credit_note.id. Fields: credit_note, direct_attachment, matched_invoices.

Response

The credit note with its attachment and matched claim invoices.

credit_note
object
required
direct_attachment
object | null
required
matched_invoices
object[]
required

Claim invoices this credit note is matched to; title is the invoice number.