SEsequencehq
Credit Note Line Items

List all Credit Note Line Item Groups

List all Credit Note Line Item Groups

get/credit-notes/{creditnote}/line-item-groups

Request

  • Base URL
    https://dev.seqhq.io/api
  • URL
    https://dev.seqhq.io/api/credit-notes/{creditnote}/line-item-groups
  • Auth
    none required

Path parameters

creditnotestring required

The CreditNote ID

Query parameters

beforestring

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.

afterstring

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.

limitinteger

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

sortOrder'ASC' | 'DESC'

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

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

OK

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.