POST
/
credit-notes
/
{creditnote}
/
line-items

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

creditnote
string
required

The CreditNote ID

Body

application/json
creditNoteId
string
required

Credit Note Line Item ID

title
string
required

Item Title

quantity
string
required

Quantity

rate
string
required

Rate per Item

taxRate
string
required

Tax Rate

externalIds
object[]
required

IDs in external integrations

groupId
string

Credit Note Line Item Group ID

lineItemId
string

Line Item ID

description
string

Item Description

rateDisplay
enum<string>

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE

Response

201 - application/json
id
string
required

Credit Note Line Item ID

creditNoteId
string
required

Credit Note Line Item ID

title
string
required

Item Title

quantity
string
required

Quantity

rate
string
required

Rate per Item

taxRate
string
required

Tax Rate

index
integer
required

Index (for maintaining order)

netTotal
string
required

Net Total

totalTax
string
required

Total Tax

grossTotal
string
required

Gross Total

rateDisplay
enum<string>
required

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE
externalIds
object[]
required

IDs in external integrations

groupId
string

Credit Note Line Item Group ID

lineItemId
string

Line Item ID

description
string

Item Description

priceId
string

Price ID

List all Credit Note Line ItemsList all Credit Note Line Item Groups