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

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Path Parameters

invoice
string
required

The Invoice ID

Body

application/json
creditGrantId
string
description
string
externalIds
object[]
required
groupId
string
priceId
string
quantity
string
required
rate
string
required
rateDisplay
enum<string>
Available options:
ABSOLUTE,
PERCENTAGE
revenueClassification
enum<string>
Available options:
PREPAYMENT,
EARNED,
BURNDOWN
servicePeriod
object
servicePeriodEnd
string
servicePeriodStart
string
taxRate
string
required
title
string
required

Response

201 - application/json
creditGrantId
string
description
string
externalIds
object[]
required
grossTotal
string
required
groupId
string
id
string
required
index
integer
required
invoiceId
string
required
netTotal
string
required
priceId
string
quantity
string
required
rate
string
required
rateDisplay
enum<string>
required
Available options:
ABSOLUTE,
PERCENTAGE
revenueClassification
enum<string>
Available options:
PREPAYMENT,
EARNED,
BURNDOWN
servicePeriod
object
servicePeriodEnd
string
servicePeriodStart
string
taxRate
string
required
title
string
required
totalTax
string
required
List all Line ItemsUpdate a Line Item