POST
/
api
/
credit-notes
/
{creditNoteId}
/
refunds

Headers

Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

creditNoteId
number
required

Body

application/json
fromAccountId
number
required

The id of the from account

Example:

1

amount
number
required

The amount of the credit note refund

Example:

100

exchangeRate
number
required

The exchange rate of the credit note refund

Example:

1

referenceNo
string
required

The reference number of the credit note refund

Example:

"123456"

description
string
required

The description of the credit note refund

Example:

"Credit note refund"

date
string<date-time>
required

The date of the credit note refund

Example:

"2021-01-01"

branchId
number
required

The id of the branch

Example:

1