Credit Note Line Items

List all Credit Note Line Items

Changed on

List all Credit Note Line Items

get/credit-notes/{creditnote}/line-items

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/credit-notes/{creditnote}/line-items
  • Auth
    none declared. Required headers: Authorization

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": "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"
        }
      ],
      "servicePeriod": {
        "start": "2025-10-01",
        "endInclusive": "2025-10-30"
      },
      "revenueRecognitionMethod": "STRAIGHT_LINE",
      "revenueClassification": "EARNED",
      "productId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

Changes

  • d01512162768Revision changes
    • breaking

      the query request parameter sortOrder was restricted to a list of enum values

    • breaking

      for the query request parameter limit, the format changed from no format to int32

    • breaking

      the /// response's property format changed from date to no format for status

    • breaking

      the /// response's property format changed from date to no format for status

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

    • info

      added the new enum value ASC to the query request parameter sortOrder

    • info

      added the new enum value DESC to the query request parameter sortOrder

  • 12ab2101be2aRevision changes
    • breaking

      removed the enum value ASC from the query request parameter sortOrder

    • breaking

      removed the enum value DESC from the query request parameter sortOrder

    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version

    • info

      for the query request parameter limit, the format was generalized from int32 to no format