Credit Note Line Items
Create a new Credit Note Line Item
Create a new Credit Note Line Item
POST
/
credit-notes
/
{creditnote}
/
line-items
Header
Path
Body
curl --request POST \
--url https://dev.seqhq.io/api/credit-notes/{creditnote}/line-items \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"title": "Ferraris",
"description": "Red",
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"rateDisplay": "ABSOLUTE",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
]
}'
{
"id": "af60cab3-812d-4250-a051-0fb7133a00c7",
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"title": "Ferraris",
"description": "Red",
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"index": 2,
"priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"netTotal": "20000.00",
"totalTax": "2000.00",
"grossTotal": "22000.00",
"rateDisplay": "ABSOLUTE",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
]
}
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Path Parameters
creditnote
string
requiredThe CreditNote ID
Body
application/json
creditNoteId
string
requiredgroupId
string
lineItemId
string
title
string
requireddescription
string
quantity
string
requiredrate
string
requiredtaxRate
string
requiredrateDisplay
enum<string>
Available options:
ABSOLUTE
, PERCENTAGE
externalIds
object[]
requiredResponse
201 - application/json
id
string
requiredcreditNoteId
string
requiredgroupId
string
lineItemId
string
title
string
requireddescription
string
quantity
string
requiredrate
string
requiredtaxRate
string
requiredindex
integer
requiredpriceId
string
netTotal
string
requiredtotalTax
string
requiredgrossTotal
string
requiredrateDisplay
enum<string>
requiredAvailable options:
ABSOLUTE
, PERCENTAGE
externalIds
object[]
requiredcurl --request POST \
--url https://dev.seqhq.io/api/credit-notes/{creditnote}/line-items \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"title": "Ferraris",
"description": "Red",
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"rateDisplay": "ABSOLUTE",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
]
}'
{
"id": "af60cab3-812d-4250-a051-0fb7133a00c7",
"creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
"lineItemId": "af60cab3-812d-4250-a051-0fb7133a00c7",
"title": "Ferraris",
"description": "Red",
"quantity": "2",
"rate": "20000.10",
"taxRate": "0.2",
"index": 2,
"priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
"netTotal": "20000.00",
"totalTax": "2000.00",
"grossTotal": "22000.00",
"rateDisplay": "ABSOLUTE",
"externalIds": [
{
"key": "Xero",
"value": "123"
}
]
}