Skip to main content
Attach a claim credit note

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
credit_note_id
string<uuid>
required
create_refund
boolean
default:false

Response

Attached credit note.

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

Claim invoices this credit note is matched to, ordered by invoice number (missing numbers last) and ID; title is the invoice number.