Skip to main content
POST
/
api
/
v1
/
invoice
/
{invoice_uuid}
/
line-items
Line Item Create Api
curl --request POST \
  --url https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Product A",
  "description": "Detailed description of the product or service",
  "quantity": 2,
  "unit_price": 100,
  "flat_fee": 10,
  "discount_amount": 5,
  "discount_percent": 10,
  "tax_rate": 10,
  "tax_name": "Sales Tax",
  "service_start_date": "2024-03-01",
  "service_end_date": "2024-03-31",
  "display_order": 2
}'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "unit_price": 123,
  "quantity": 123,
  "amount": 123,
  "currency": "<string>",
  "description": "<string>",
  "flat_fee": 123,
  "tax_rate": 123,
  "tax_amount": 123,
  "tax_name": "<string>",
  "discount_amount": 123,
  "discount_percent": 123,
  "service_start_date": "2023-12-25",
  "service_end_date": "2023-12-25",
  "display_order": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
invoice_uuid
string
required

Body

application/json

Input schema for creating a line item.

​
name
string
required

Name of the line item

Example:

"Product A"

​
unit_price
number
required

Price per unit

Example:

100

​
description
string | null

Additional details about the line item

Example:

"Detailed description of the product or service"

​
quantity
integer
default:1

Quantity of units

Required range: x >= 1
Example:

2

​
flat_fee
number | null

Fixed flat fee amount

Example:

10

​
discount_amount
number | null

Discount amount in currency

Example:

5

​
discount_percent
number | null

Discount percentage (0-100)

Required range: 0 <= x <= 100
Example:

10

​
tax_rate
number | null

Tax rate percentage (0-100)

Required range: 0 <= x <= 100
Example:

10

​
tax_name
string | null

Name of the tax applied

Example:

"Sales Tax"

​
service_start_date
string<date> | null

Service period start date

Example:

"2024-03-01"

​
service_end_date
string<date> | null

Service period end date

Example:

"2024-03-31"

​
display_order
integer | null

Display order for line item

Required range: x >= 1

Response

Line item created successfully

Output schema for invoice line items with UUID for external API.

​
uuid
string<uuid>
​
name
string | null
Maximum length: 255
​
unit_price
number | null
​
quantity
integer | null
​
amount
number | null
​
currency
string | null
Maximum length: 3
​
description
string | null

The description of the line item

​
flat_fee
number | null

Fixed flat fee added to the line item amount

​
tax_rate
number | null
​
tax_amount
number | null
​
tax_name
string | null
Maximum length: 255
​
discount_amount
number | null
​
discount_percent
number | null
​
service_start_date
string<date> | null

The date the service starts for the item

​
service_end_date
string<date> | null

The date the service ends for the item

​
display_order
integer | null

The order in which the line item will be displayed in the UI/pdf