Skip to main content
POST
/
invoices
/
{invoice}
/
line-items
Create a new Line Item
curl --request POST \
  --url https://dev.seqhq.io/api/invoices/{invoice}/line-items \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Ferraris",
  "description": "Red",
  "quantity": "2",
  "rate": "20000.10",
  "taxRate": "0.2",
  "servicePeriodStart": "2022-10-20T00:00:00Z",
  "servicePeriodEnd": "2022-10-24T00:00:00Z",
  "servicePeriod": {
    "startDate": "2022-10-20",
    "endDate": "2022-10-24"
  },
  "groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
  "priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "rateDisplay": "ABSOLUTE",
  "externalIds": [
    {
      "key": "Xero",
      "value": "123"
    }
  ],
  "revenueClassification": "EARNED",
  "creditGrantId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "revenueRecognitionMethod": "STRAIGHT_LINE"
}
'
{
  "id": "af60cab3-812d-4250-a051-0fb7133a00c7",
  "invoiceId": "cd11218d-fa00-4faa-8684-a43113d076a8",
  "title": "Ferraris",
  "description": "Red",
  "quantity": "2",
  "rate": "20000.10",
  "taxRate": "0.2",
  "servicePeriodStart": "2022-10-20T00:00:00Z",
  "servicePeriodEnd": "2022-10-24T00:00:00Z",
  "servicePeriod": {
    "startDate": "2022-10-20",
    "endDate": "2022-10-24"
  },
  "index": 2,
  "groupId": "cd11218d-fa00-4faa-8684-a43113d076a8",
  "netTotal": "51.20",
  "totalTax": "2.50",
  "grossTotal": "101.23",
  "priceId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "rateDisplay": "ABSOLUTE",
  "externalIds": [
    {
      "key": "Xero",
      "value": "123"
    }
  ],
  "revenueClassification": "EARNED",
  "creditGrantId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "productId": "dd55bf30-3b97-4644-a9fc-b15e0f59a110",
  "revenueRecognitionMethod": "USAGE"
}

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

Body

application/json
​
title
string
required

Item Title

Example:

"Ferraris"

​
quantity
string
required

Quantity

Example:

"2"

​
rate
string
required

Price per Item

Example:

"20000.10"

​
taxRate
string
required

Tax Rate

Example:

"0.2"

​
externalIds
object[]
required

IDs in external integrations

Example:
[{ "key": "Xero", "value": "123" }]
​
description
string

Item Description

Example:

"Red"

​
servicePeriodStart
string

Start of the service period (the time period in which the service was provided)

Example:

"2022-10-20T00:00:00Z"

​
servicePeriodEnd
string

End of the service period (the time period in which the service was provided)

Example:

"2022-10-24T00:00:00Z"

​
servicePeriod
object

Service Period

Example:
{
  "startDate": "2022-10-20",
  "endDate": "2022-10-24"
}
​
groupId
string

Line Item Group ID

Example:

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

​
priceId
string

Price ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

​
rateDisplay
enum<string>

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE
Example:

"ABSOLUTE"

​
revenueClassification
enum<string>

Revenue classification

Available options:
PREPAYMENT,
EARNED,
BURNDOWN
Example:

"EARNED"

​
creditGrantId
string

Credit Grant ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

​
revenueRecognitionMethod
enum<string>

Revenue recognition method

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

"STRAIGHT_LINE"

Response

Created

​
id
string
required

Line Item ID

Example:

"af60cab3-812d-4250-a051-0fb7133a00c7"

​
invoiceId
string
required

Invoice ID

Example:

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

​
title
string
required

Item Title

Example:

"Ferraris"

​
quantity
string
required

Quantity

Example:

"2"

​
rate
string
required

Price per Item

Example:

"20000.10"

​
taxRate
string
required

Tax Rate

Example:

"0.2"

​
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"

​
rateDisplay
enum<string>
required

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE
Example:

"ABSOLUTE"

​
externalIds
object[]
required

IDs in external integrations

Example:
[{ "key": "Xero", "value": "123" }]
​
description
string

Item Description

Example:

"Red"

​
servicePeriodStart
string

Start of the service period (the time period in which the service was provided)

Example:

"2022-10-20T00:00:00Z"

​
servicePeriodEnd
string

End of the service period (the time period in which the service was provided)

Example:

"2022-10-24T00:00:00Z"

​
servicePeriod
object

Service Period

Example:
{
  "startDate": "2022-10-20",
  "endDate": "2022-10-24"
}
​
groupId
string

Line Item Group ID

Example:

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

​
priceId
string

Price ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

​
revenueClassification
enum<string>

Revenue classification

Available options:
PREPAYMENT,
EARNED,
BURNDOWN
Example:

"EARNED"

​
creditGrantId
string

Credit Grant ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

​
productId
string

Product ID

Example:

"dd55bf30-3b97-4644-a9fc-b15e0f59a110"

​
revenueRecognitionMethod
enum<string>

Revenue recognition method

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

"STRAIGHT_LINE"