Credit Note Line Items

Update a Credit Note Line Item

Changed on

Update a Credit Note Line Item

put/credit-notes/{creditnote}/line-items/{id}

Request

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

Path parameters

creditnotestring required

The CreditNote ID

idstring required

Credit Note Line Item ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

titlestring required

Item Title

descriptionstring

Item Description

quantitystring required

Quantity

ratestring required

Rate per Item

taxRatestring required

Tax Rate

rateDisplay'ABSOLUTE' | 'PERCENTAGE'
revenueRecognitionMethod'STRAIGHT_LINE' | 'USAGE' | 'MILESTONE' | 'POINT_IN_TIME'
revenueClassification'PREPAYMENT' | 'EARNED' | 'BURNDOWN'
productIdstring

Product ID

Example request

{
  "title": "Ferraris",
  "description": "Red",
  "quantity": "2",
  "rate": "20000.10",
  "taxRate": "0.2",
  "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"
}

Response

OK

idstring required

Credit Note Line Item ID

creditNoteIdstring required

Credit Note Line Item ID

groupIdstring

Credit Note Line Item Group ID

lineItemIdstring

Line Item ID

titlestring required

Item Title

descriptionstring

Item Description

quantitystring required

Quantity

ratestring required

Rate per Item

taxRatestring required

Tax Rate

indexinteger required

Index (for maintaining order)

priceIdstring

Price ID

netTotalstring required

Net Total

totalTaxstring required

Total Tax

grossTotalstring required

Gross Total

rateDisplay'ABSOLUTE' | 'PERCENTAGE' required
revenueRecognitionMethod'STRAIGHT_LINE' | 'USAGE' | 'MILESTONE' | 'POINT_IN_TIME'
revenueClassification'PREPAYMENT' | 'EARNED' | 'BURNDOWN'
productIdstring

Product ID

Example response

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

Changes

  • d01512162768Revision changes
    • 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

      the / request property format was generalized from date to no format

    • info

      the / request property format was generalized from date to no format

  • 12ab2101be2aRevision changes
    • breaking

      the / request property format changed from no format to date

    • breaking

      the / request property format changed from no format to date

    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version