Skip to main content
POST

Headers

string
default:"1.2"
required
The API version to use. Supported versions are 1.1 and 1.2.
string
A unique key so a retried request is not processed twice.

Request Body Parameters

string
required
The unique identifier (UUID) of the target invoice to credit.
number
required
The total amount to credit. Must be greater than 0.
string
Three-letter ISO currency code (e.g. AUD, USD, EUR). Defaults to AUD.
string
required
Reason category for issuing credit (e.g. Overbilled service hours, Customer discount / Service dispute, Billing error / Price adjustment).
string
Detailed explanatory notes or accounting memo.

Response Body

number
HTTP status code (200 / 201).
string
Confirmation message describing the operation result.
string
Unique identifier of the created credit note draft.
string
Set to DRAFT until the credit note is officially issued.
string
Current lifecycle state, initially DRAFT.
number
The total credit amount for this credit note.
number
Unallocated credit balance remaining.

Response Codes

Last modified on November 10, 2026