Skip to main content
POST
Import a credit note

Authorizations

Authorization
string
header
required

Body

application/json

Credit note object to import

clientId
string<uuid>
required
reference
string
required
Maximum string length: 80
amount
integer
required
Required range: x >= 0
netAmount
integer
required
Required range: x >= 0
issueDate
string<date>
required
dueDate
string<date>
required
externalId
string | null
Maximum string length: 80

Response

Returns the imported 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>