Skip to main content
PUT

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.

Path Parameters

string
required
The unique ID (UUID) of the draft credit note to update.

Request Body Parameters

number
required
Updated credit amount. Must be greater than 0.
string
Currency code (e.g. AUD).
string
required
Updated reason for issuing the credit.
string
Updated memo or internal accounting remarks.
string
Updated target invoice UUID, if reassigning to a different invoice.

Response Body

number
HTTP status code (200).
string
Confirmation message describing the update.
object
The updated draft credit note entity.

Response Codes

Last modified on November 10, 2026