Skip to main content
POST
Issue credit note

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
invoiceRef
string
required

The billing provider (Received) invoice ID

Maximum string length: 255

Body

application/json

Input for issuing a credit note against an invoice.

reasonCode
string

Why the credit is being issued, e.g. ORDER_CHANGE, ORDER_CANCELLATION, WAIVER. Defaults to ORDER_CHANGE

Maximum string length: 255
issueDate
string<date-time>

Issue date for the credit note. Defaults to now

Response

The issued credit note.

Response object

data
CreditNote · object
required

A credit note raised against one or more invoices — how a change to a contract that can no longer be amended gets settled.