PUT
/
invoices
/
{invoice}
/
line-items
/
{id}

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 ID

Body

application/json
title
string
required

Item Title

quantity
string
required

Quantity

rate
string
required

Price per Item

taxRate
string
required

Tax Rate

externalIds
object[]
required

IDs in external integrations

description
string

Item Description

servicePeriodStart
string

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

servicePeriodEnd
string

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

servicePeriod
object

Service Period

groupId
string

Line Item Group ID

priceId
string

Price ID

rateDisplay
enum<string>

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE
revenueClassification
enum<string>

Revenue classification

Available options:
PREPAYMENT,
EARNED,
BURNDOWN
creditGrantId
string

Credit Grant ID

Response

200 - application/json
id
string
required

Line Item ID

invoiceId
string
required

Invoice ID

title
string
required

Item Title

quantity
string
required

Quantity

rate
string
required

Price per Item

taxRate
string
required

Tax Rate

index
integer
required

Index (for maintaining order)

netTotal
string
required

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

totalTax
string
required

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

grossTotal
string
required

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

rateDisplay
enum<string>
required

Determines whether rate is displayed as an absolute value or percentage

Available options:
ABSOLUTE,
PERCENTAGE
externalIds
object[]
required

IDs in external integrations

description
string

Item Description

servicePeriodStart
string

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

servicePeriodEnd
string

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

servicePeriod
object

Service Period

groupId
string

Line Item Group ID

priceId
string

Price ID

revenueClassification
enum<string>

Revenue classification

Available options:
PREPAYMENT,
EARNED,
BURNDOWN
creditGrantId
string

Credit Grant ID

Create a new Line Item GroupDeletes a Line Item