PUT
/
invoices
/
{invoice}
/
line-item-groups
/
{id}
Update a Line Item Group
curl --request PUT \
  --url https://eu.sequencehq.com/api/invoices/{invoice}/line-item-groups/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
}'
{
  "id": "4639a112-f821-4bc1-bc2d-6f9ece5b7c0f",
  "invoiceId": "cd11218d-fa00-4faa-8684-a43113d076a8",
  "title": "Users",
  "description": "Charges for users",
  "index": 2,
  "netTotal": "51.20",
  "totalTax": "2.50",
  "grossTotal": "101.23",
  "taxCategory": {
    "id": "28227c88-6dba-455f-9b30-b9c76957e610",
    "name": "VAT"
  }
}

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

​
invoice
string
required

The Invoice ID

​
id
string
required

Line Item Group ID

Body

application/json
​
title
string
required

Line Item Group Title

Example:

"Users"

​
description
string

Line Item Group Description

Example:

"Charges for users"

​
taxCategoryId
string

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

Example:

"28227c88-6dba-455f-9b30-b9c76957e610"

​
revenueRecognitionMethod
enum<string>

The revenue recognition method for all line items in this line item group

Available options:
STRAIGHT_LINE,
USAGE,
MILESTONE,
POINT_IN_TIME
Example:

"STRAIGHT_LINE"

​
revenueClassification
enum<string>

The revenue classification for all line items in this line item group

Available options:
PREPAYMENT,
EARNED,
BURNDOWN
Example:

"EARNED"

​
servicePeriod
object

Billing period

Example:
{
  "start": "2022-10-01",
  "endInclusive": "2022-10-30"
}
​
index
integer

Index (for maintaining order)

Example:

10

Response

OK

​
id
string
required

Line Item Group ID

Example:

"4639a112-f821-4bc1-bc2d-6f9ece5b7c0f"

​
invoiceId
string
required

Invoice ID

Example:

"cd11218d-fa00-4faa-8684-a43113d076a8"

​
title
string
required

Line Item Group Title

Example:

"Users"

​
index
integer
required

Index (for maintaining order)

Example:

2

​
netTotal
string
required

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

Example:

"51.20"

​
totalTax
string
required

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

Example:

"2.50"

​
grossTotal
string
required

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

Example:

"101.23"

​
description
string

Line Item Group Description

Example:

"Charges for users"

​
taxCategory
object

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

Example:
{
  "id": "28227c88-6dba-455f-9b30-b9c76957e610",
  "name": "VAT"
}