Skip to main content
POST
/
credit-notes
/
{creditnote}
/
line-item-groups
Create a new Credit Note Line Item Group
curl --request POST \
  --url https://dev.seqhq.io/api/credit-notes/{creditnote}/line-item-groups \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lineItemGroupId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "title": "Users",
  "description": "Credit note for users"
}
'
{
  "id": "e5bc0f12-4bc1-f821-bc2d-04639a16f9ec",
  "creditNoteId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "lineItemGroupId": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "title": "Users",
  "description": "Credit note for users",
  "index": 2,
  "netTotal": "51.20",
  "totalTax": "2.50",
  "grossTotal": "101.23"
}

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
​
title
string
required

Credit Note Line Item Group Title

Example:

"Users"

​
lineItemGroupId
string

Line Item Group ID

Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
description
string

Credit Note Line Item Group Description

Example:

"Credit note for users"

Response

Created

​
id
string
required

Credit Note Line Item Group ID

Example:

"e5bc0f12-4bc1-f821-bc2d-04639a16f9ec"

​
creditNoteId
string
required

Credit Note ID

Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
title
string
required

Credit Note Line Item Group Title

Example:

"Users"

​
index
integer
required

Index (for maintaining order)

Example:

2

​
netTotal
string
required

Net total

Example:

"51.20"

​
totalTax
string
required

Total tax

Example:

"2.50"

​
grossTotal
string
required

Gross total

Example:

"101.23"

​
lineItemGroupId
string

Line Item Group ID

Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
description
string

Credit Note Line Item Group Description

Example:

"Credit note for users"