Skip to main content
GET
Find a credit note by its id

Authorizations

Authorization
string
header
required

Path Parameters

creditNoteId
string<uuid>
required

Id of the credit note

Response

Found credit note

id
string<uuid>
tenantId
string<uuid>
clientId
string<uuid>
externalId
string | null
reference
string
amount
integer
remainingAmount
integer
paybackAmount
integer
deductedAmount
integer
issueDate
string<date-time>
paybacks
object[]
status
enum<string>

Credit note status

Available options:
available,
deducted,
disputed,
recovery
createdAt
string<date-time>
updatedAt
string<date-time>