Skip to main content
GET

Headers

string
default:"1.2"
required
The API version to use. Supported versions are 1.1 and 1.2.

Path Parameters

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

Response Body

string
Unique identifier (UUID) of the credit note.
string
Credit note code (e.g. CN-2026-0089 or DRAFT).
string
Current status (DRAFT, ISSUED, PARTIALLY_APPLIED, FULLY_APPLIED, or VOIDED).
number
Total credit granted.
number
Cumulative amount applied to date.
number
Remaining credit balance available for invoice allocation.
string
Target invoice UUID.
string
Associated customer or client name.

Response Codes

Last modified on November 10, 2026