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",
  "unit_price": 100,
  "description": "Detailed description of the product or service",
  "quantity": 2,
  "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
}
'

import requests

url = "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items"

payload = {
    "name": "Product A",
    "unit_price": 100,
    "description": "Detailed description of the product or service",
    "quantity": 2,
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Product A',
    unit_price: 100,
    description: 'Detailed description of the product or service',
    quantity: 2,
    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
  })
};

fetch('https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Product A',
    'unit_price' => 100,
    'description' => 'Detailed description of the product or service',
    'quantity' => 2,
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items"

	payload := strings.NewReader("{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "unit_price": 123,
  "quantity": 1,
  "amount": 123,
  "currency": "USD",
  "description": "<string>",
  "flat_fee": 123,
  "tax_rate": 0,
  "tax_amount": 0,
  "tax_name": "<string>",
  "discount_amount": 123,
  "discount_percent": 123,
  "service_start_date": "2023-12-25",
  "service_end_date": "2023-12-25",
  "display_order": 123
}

{}

{}

POST

api

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",
  "unit_price": 100,
  "description": "Detailed description of the product or service",
  "quantity": 2,
  "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
}
'

import requests

url = "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items"

payload = {
    "name": "Product A",
    "unit_price": 100,
    "description": "Detailed description of the product or service",
    "quantity": 2,
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Product A',
    unit_price: 100,
    description: 'Detailed description of the product or service',
    quantity: 2,
    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
  })
};

fetch('https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Product A',
    'unit_price' => 100,
    'description' => 'Detailed description of the product or service',
    'quantity' => 2,
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items"

	payload := strings.NewReader("{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.justpaid.io/api/v1/invoice/{invoice_uuid}/line-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Product A\",\n  \"unit_price\": 100,\n  \"description\": \"Detailed description of the product or service\",\n  \"quantity\": 2,\n  \"flat_fee\": 10,\n  \"discount_amount\": 5,\n  \"discount_percent\": 10,\n  \"tax_rate\": 10,\n  \"tax_name\": \"Sales Tax\",\n  \"service_start_date\": \"2024-03-01\",\n  \"service_end_date\": \"2024-03-31\",\n  \"display_order\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "unit_price": 123,
  "quantity": 1,
  "amount": 123,
  "currency": "USD",
  "description": "<string>",
  "flat_fee": 123,
  "tax_rate": 0,
  "tax_amount": 0,
  "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 string length: 255

unit_price

number | null

quantity

integer | null

default:1

amount

number | null

currency

string | null

default:USD

Maximum string 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

default:0

tax_amount

number | null

default:0

tax_name

string | null

Maximum string 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

Invoice Pdf Get Api Line Item Get Api