Credit Note Line Items
Create a new CreditNoteLineItem
Create a new CreditNoteLineItem
POST
/
credit-notes
/
{creditnote}
/
line-items
Header
Path
Body
curl --request POST \
--url https://eu.sequencehq.com/api/credit-notes/{creditnote}/line-items \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
],
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"title": "Ferraris"
}'
{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"description": "Red",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
],
"grossTotal": "22000.00",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"id": "af60cab3-812d-4250-a051-0fb7133a00c7",
"index": 2,
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"netTotal": "20000.00",
"priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"quantity": "2",
"rate": "20000.10",
"rateDisplay": "ABSOLUTE",
"taxRate": "0.2",
"title": "Ferraris",
"totalTax": "2000.00"
}
Headers
Authorizationrequired
string
Your API credentials. Eg. Basic {credentials}
.
Idempotency-Key
string
Specifying a unique ID for this request here lets you retry it without risk of performing the same operation twice.
Path Parameters
creditnoterequired
string
The CreditNote ID
Body
application/json
creditNoteIdrequired
string
description
string
externalIdsrequired
object[]
groupId
string
lineItemId
string
quantityrequired
string
raterequired
string
rateDisplay
enum<string>
Available options:
ABSOLUTE
, PERCENTAGE
taxRaterequired
string
titlerequired
string
Response
201 - application/json
creditNoteIdrequired
string
description
string
externalIdsrequired
object[]
grossTotalrequired
string
groupId
string
idrequired
string
indexrequired
integer
lineItemId
string
netTotalrequired
string
priceId
string
quantityrequired
string
raterequired
string
rateDisplayrequired
enum<string>
Available options:
ABSOLUTE
, PERCENTAGE
taxRaterequired
string
titlerequired
string
totalTaxrequired
string
curl --request POST \
--url https://eu.sequencehq.com/api/credit-notes/{creditnote}/line-items \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
],
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"title": "Ferraris"
}'
{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"description": "Red",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
],
"grossTotal": "22000.00",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"id": "af60cab3-812d-4250-a051-0fb7133a00c7",
"index": 2,
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"netTotal": "20000.00",
"priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"quantity": "2",
"rate": "20000.10",
"rateDisplay": "ABSOLUTE",
"taxRate": "0.2",
"title": "Ferraris",
"totalTax": "2000.00"
}