Skip to main content
GET
/
credit-notes
/
{creditnote}
/
line-item-groups
List all Credit Note Line Item Groups
curl --request GET \
  --url https://dev.seqhq.io/api/credit-notes/{creditnote}/line-item-groups \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "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"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

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

Query Parameters

​
before
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

​
after
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

​
limit
integer

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

​
sortOrder
string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

Response

OK

​
items
object[]
required

CreditNoteLineItemGroups

Example:
[
  {
    "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"
  }
]
​
pagination
object
required

Results pagination

Example:
{
  "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
  "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
  "totalResultSize": 10
}