Invoice Line Items

Update a Line Item Group

Update a Line Item Group

put/invoices/{invoice}/line-item-groups/{id}

Path parameters

invoicestring required

The Invoice ID

idstring required

Line Item Group 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

Line Item Group Title

descriptionstring

Line Item Group Description

taxCategoryIdstring

The tax category for all line items in this line item group

revenueRecognitionMethod'STRAIGHT_LINE' | 'USAGE' | 'MILESTONE' | 'POINT_IN_TIME'
revenueClassification'PREPAYMENT' | 'EARNED' | 'BURNDOWN'
indexinteger

Index (for maintaining order)

Example request

{
  "title": "Users",
  "description": "Charges for users",
  "taxCategoryId": "28227c88-6dba-455f-9b30-b9c76957e610",
  "revenueRecognitionMethod": "STRAIGHT_LINE",
  "revenueClassification": "EARNED",
  "servicePeriod": {
    "start": "2022-10-20",
    "endInclusive": "2022-10-24"
  },
  "index": 10
}

Response

OK

idstring required

Line Item Group ID

invoiceIdstring required

Invoice ID

titlestring required

Line Item Group Title

descriptionstring

Line Item Group Description

indexinteger required

Index (for maintaining order)

netTotalstring required

Net total, in decimal format of the Invoice's currency

totalTaxstring required

Total tax, in decimal format of the Invoice's currency

grossTotalstring required

Gross total, in decimal format of the Invoice's currency

Example response

{
  "id": "941272d1-f840-4e16-b698-0cd455c81e0e",
  "invoiceId": "cd11218d-fa00-4faa-8684-a43113d076a8",
  "title": "Cars",
  "description": "Charges for cars",
  "index": 1,
  "netTotal": "200000",
  "totalTax": "10",
  "grossTotal": "22000",
  "taxCategory": {
    "id": "28227c88-6dba-455f-9b30-b9c76957e610",
    "name": "VAT"
  }
}

Changes

Changed in 3 of the 714 revisions of this API.237

  • d0151216276813See the full diff
    • deleted the header request parameter Sequence-Version

      request-parameter-removed

    • added the new optional header request parameter sequence-version

      new-optional-request-parameter

    • the servicePeriod/endInclusive request property type/format was generalized from string/date to string/

      request-property-type-generalized

    • the servicePeriod/start request property type/format was generalized from string/date to string/

      request-property-type-generalized

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 12ab2101be2a211See the full diff
    • the servicePeriod/endInclusive request property type/format changed from string/ to string/date

      request-property-type-changed

    • the servicePeriod/start request property type/format changed from string/ to string/date

      request-property-type-changed

    • deleted the header request parameter sequence-version

      request-parameter-removed

    • added the new optional header request parameter Sequence-Version

      new-optional-request-parameter

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c5cfe471a2b313See the full diff
    • deleted the header request parameter Sequence-Version

      request-parameter-removed

    • added the new optional header request parameter sequence-version

      new-optional-request-parameter

    • the servicePeriod/endInclusive request property type/format was generalized from string/date to string/

      request-property-type-generalized

    • the servicePeriod/start request property type/format was generalized from string/date to string/

      request-property-type-generalized

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog