Create invoice
curl --request POST \
--url https://app.blinksale.test/api/v1/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"currency": "USD",
"tax_distribution": "PER_DOCUMENT",
"discount_distribution": "NO_DISCOUNT",
"net_terms": "NET30",
"line_items": [
{
"name": "Consulting Services",
"quantity": 10,
"price": 150,
"description": "Professional consulting services",
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 0
}
],
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"discount_type": "PERCENTAGE",
"discount_value": 10,
"has_late_fee": true,
"late_fee_kind": "PERCENTAGE",
"late_fee_interval": "ONE_TIME",
"late_fee": 5,
"shipping": 0,
"notes": "Payment due within 30 days",
"options": {},
"issued_at": "2023-06-15"
}
'import requests
url = "https://app.blinksale.test/api/v1/invoices"
payload = {
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"currency": "USD",
"tax_distribution": "PER_DOCUMENT",
"discount_distribution": "NO_DISCOUNT",
"net_terms": "NET30",
"line_items": [
{
"name": "Consulting Services",
"quantity": 10,
"price": 150,
"description": "Professional consulting services",
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 0
}
],
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"discount_type": "PERCENTAGE",
"discount_value": 10,
"has_late_fee": True,
"late_fee_kind": "PERCENTAGE",
"late_fee_interval": "ONE_TIME",
"late_fee": 5,
"shipping": 0,
"notes": "Payment due within 30 days",
"options": {},
"issued_at": "2023-06-15"
}
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({
client_id: '01jtbf0c9zaraqx3swthf88n5y',
currency: 'USD',
tax_distribution: 'PER_DOCUMENT',
discount_distribution: 'NO_DISCOUNT',
net_terms: 'NET30',
line_items: [
{
name: 'Consulting Services',
quantity: 10,
price: 150,
description: 'Professional consulting services',
unit_of_measurement_id: '01jtbf0c9zaraqx3swthf88n5y',
tax_id: '01jtbf0c9zaraqx3swthf88n5y',
tax_name: 'Sales Tax',
tax_percent: 8.5,
discount_type: 'PERCENTAGE',
discount_value: 0
}
],
tax_id: '01jtbf0c9zaraqx3swthf88n5y',
discount_type: 'PERCENTAGE',
discount_value: 10,
has_late_fee: true,
late_fee_kind: 'PERCENTAGE',
late_fee_interval: 'ONE_TIME',
late_fee: 5,
shipping: 0,
notes: 'Payment due within 30 days',
options: {},
issued_at: '2023-06-15'
})
};
fetch('https://app.blinksale.test/api/v1/invoices', 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://app.blinksale.test/api/v1/invoices",
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([
'client_id' => '01jtbf0c9zaraqx3swthf88n5y',
'currency' => 'USD',
'tax_distribution' => 'PER_DOCUMENT',
'discount_distribution' => 'NO_DISCOUNT',
'net_terms' => 'NET30',
'line_items' => [
[
'name' => 'Consulting Services',
'quantity' => 10,
'price' => 150,
'description' => 'Professional consulting services',
'unit_of_measurement_id' => '01jtbf0c9zaraqx3swthf88n5y',
'tax_id' => '01jtbf0c9zaraqx3swthf88n5y',
'tax_name' => 'Sales Tax',
'tax_percent' => 8.5,
'discount_type' => 'PERCENTAGE',
'discount_value' => 0
]
],
'tax_id' => '01jtbf0c9zaraqx3swthf88n5y',
'discount_type' => 'PERCENTAGE',
'discount_value' => 10,
'has_late_fee' => true,
'late_fee_kind' => 'PERCENTAGE',
'late_fee_interval' => 'ONE_TIME',
'late_fee' => 5,
'shipping' => 0,
'notes' => 'Payment due within 30 days',
'options' => [
],
'issued_at' => '2023-06-15'
]),
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://app.blinksale.test/api/v1/invoices"
payload := strings.NewReader("{\n \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\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://app.blinksale.test/api/v1/invoices")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinksale.test/api/v1/invoices")
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 \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invoice created successfully",
"data": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"organization_id": "01jtbf0c9zaraqx3swthf88n5y",
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"converted_from": "01jtbf0c9zaraqx3swthf88n5y",
"converted_from_number": "EST-00001",
"invoice_number": "INV-00001",
"prefix": "INV-",
"number": 1,
"currency": "USD",
"currency_name": "US Dollar",
"currency_symbol": "$",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"tax_distribution": "PER_DOCUMENT",
"tax_distribution_name": "Per Document",
"discount_type": "PERCENTAGE",
"discount_type_name": "Percentage",
"discount_value": 10,
"discount_distribution": "PER_DOCUMENT",
"discount_distribution_name": "Per Document",
"net_terms": "NET30",
"net_terms_name": "Net 30",
"has_late_fee": true,
"late_fee_kind": "PERCENTAGE",
"late_fee_kind_name": "Percentage",
"late_fee_interval": "ONE_TIME",
"late_fee_interval_name": "One Time",
"late_fee": 5,
"next_late_fee_update_at": "2023-11-07T05:31:56Z",
"total_late_fee": 0,
"shipping": 15,
"total": 1642.5,
"total_paid": 0,
"total_due": 1642.5,
"total_due_unsettled": 1642.5,
"notes": "Payment due within 30 days.",
"options": {},
"status": "DRAFT",
"status_name": "Draft",
"is_editable": true,
"issued_at": "2023-06-15",
"due_at": "2023-07-15",
"client": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Acme Inc",
"email": "[email protected]",
"kind": "BUSINESS",
"kind_name": "Business",
"profile": {
"company_name": "Acme Inc",
"website": "https://acme.com"
},
"address": {
"line1": "123 Main St",
"line2": "Suite 101",
"city": "San Francisco",
"state": "CA",
"zip": "94107",
"country": "US"
},
"document_defaults": {
"currency": "USD"
},
"contact_count": 3,
"note_count": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"organization": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Acme Inc",
"stripe_id": "<string>",
"subscription": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trial_ends_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"profile": {},
"role": "OWNER",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"line_items": [
{
"id": "01jtbf0c9zaraqx3swthf88n5y",
"organization_id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Consulting Services",
"description": "Professional consulting services",
"quantity": 10,
"price": 150,
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"unit_name": "Hour",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 10,
"subtotal": 1500,
"tax_amount": 127.5,
"total": 1627.5
}
],
"subtotal": 1500,
"document_discount": 0,
"tax_amount": 127.5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}{
"success": false,
"message": "Validation error",
"errors": {
"email": [
"The email field must be a valid email address."
]
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}Invoices
Create Invoice
Create a new invoice
POST
/
v1
/
invoices
Create invoice
curl --request POST \
--url https://app.blinksale.test/api/v1/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"currency": "USD",
"tax_distribution": "PER_DOCUMENT",
"discount_distribution": "NO_DISCOUNT",
"net_terms": "NET30",
"line_items": [
{
"name": "Consulting Services",
"quantity": 10,
"price": 150,
"description": "Professional consulting services",
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 0
}
],
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"discount_type": "PERCENTAGE",
"discount_value": 10,
"has_late_fee": true,
"late_fee_kind": "PERCENTAGE",
"late_fee_interval": "ONE_TIME",
"late_fee": 5,
"shipping": 0,
"notes": "Payment due within 30 days",
"options": {},
"issued_at": "2023-06-15"
}
'import requests
url = "https://app.blinksale.test/api/v1/invoices"
payload = {
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"currency": "USD",
"tax_distribution": "PER_DOCUMENT",
"discount_distribution": "NO_DISCOUNT",
"net_terms": "NET30",
"line_items": [
{
"name": "Consulting Services",
"quantity": 10,
"price": 150,
"description": "Professional consulting services",
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 0
}
],
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"discount_type": "PERCENTAGE",
"discount_value": 10,
"has_late_fee": True,
"late_fee_kind": "PERCENTAGE",
"late_fee_interval": "ONE_TIME",
"late_fee": 5,
"shipping": 0,
"notes": "Payment due within 30 days",
"options": {},
"issued_at": "2023-06-15"
}
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({
client_id: '01jtbf0c9zaraqx3swthf88n5y',
currency: 'USD',
tax_distribution: 'PER_DOCUMENT',
discount_distribution: 'NO_DISCOUNT',
net_terms: 'NET30',
line_items: [
{
name: 'Consulting Services',
quantity: 10,
price: 150,
description: 'Professional consulting services',
unit_of_measurement_id: '01jtbf0c9zaraqx3swthf88n5y',
tax_id: '01jtbf0c9zaraqx3swthf88n5y',
tax_name: 'Sales Tax',
tax_percent: 8.5,
discount_type: 'PERCENTAGE',
discount_value: 0
}
],
tax_id: '01jtbf0c9zaraqx3swthf88n5y',
discount_type: 'PERCENTAGE',
discount_value: 10,
has_late_fee: true,
late_fee_kind: 'PERCENTAGE',
late_fee_interval: 'ONE_TIME',
late_fee: 5,
shipping: 0,
notes: 'Payment due within 30 days',
options: {},
issued_at: '2023-06-15'
})
};
fetch('https://app.blinksale.test/api/v1/invoices', 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://app.blinksale.test/api/v1/invoices",
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([
'client_id' => '01jtbf0c9zaraqx3swthf88n5y',
'currency' => 'USD',
'tax_distribution' => 'PER_DOCUMENT',
'discount_distribution' => 'NO_DISCOUNT',
'net_terms' => 'NET30',
'line_items' => [
[
'name' => 'Consulting Services',
'quantity' => 10,
'price' => 150,
'description' => 'Professional consulting services',
'unit_of_measurement_id' => '01jtbf0c9zaraqx3swthf88n5y',
'tax_id' => '01jtbf0c9zaraqx3swthf88n5y',
'tax_name' => 'Sales Tax',
'tax_percent' => 8.5,
'discount_type' => 'PERCENTAGE',
'discount_value' => 0
]
],
'tax_id' => '01jtbf0c9zaraqx3swthf88n5y',
'discount_type' => 'PERCENTAGE',
'discount_value' => 10,
'has_late_fee' => true,
'late_fee_kind' => 'PERCENTAGE',
'late_fee_interval' => 'ONE_TIME',
'late_fee' => 5,
'shipping' => 0,
'notes' => 'Payment due within 30 days',
'options' => [
],
'issued_at' => '2023-06-15'
]),
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://app.blinksale.test/api/v1/invoices"
payload := strings.NewReader("{\n \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\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://app.blinksale.test/api/v1/invoices")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinksale.test/api/v1/invoices")
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 \"client_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"currency\": \"USD\",\n \"tax_distribution\": \"PER_DOCUMENT\",\n \"discount_distribution\": \"NO_DISCOUNT\",\n \"net_terms\": \"NET30\",\n \"line_items\": [\n {\n \"name\": \"Consulting Services\",\n \"quantity\": 10,\n \"price\": 150,\n \"description\": \"Professional consulting services\",\n \"unit_of_measurement_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"tax_name\": \"Sales Tax\",\n \"tax_percent\": 8.5,\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 0\n }\n ],\n \"tax_id\": \"01jtbf0c9zaraqx3swthf88n5y\",\n \"discount_type\": \"PERCENTAGE\",\n \"discount_value\": 10,\n \"has_late_fee\": true,\n \"late_fee_kind\": \"PERCENTAGE\",\n \"late_fee_interval\": \"ONE_TIME\",\n \"late_fee\": 5,\n \"shipping\": 0,\n \"notes\": \"Payment due within 30 days\",\n \"options\": {},\n \"issued_at\": \"2023-06-15\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invoice created successfully",
"data": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"organization_id": "01jtbf0c9zaraqx3swthf88n5y",
"client_id": "01jtbf0c9zaraqx3swthf88n5y",
"converted_from": "01jtbf0c9zaraqx3swthf88n5y",
"converted_from_number": "EST-00001",
"invoice_number": "INV-00001",
"prefix": "INV-",
"number": 1,
"currency": "USD",
"currency_name": "US Dollar",
"currency_symbol": "$",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"tax_distribution": "PER_DOCUMENT",
"tax_distribution_name": "Per Document",
"discount_type": "PERCENTAGE",
"discount_type_name": "Percentage",
"discount_value": 10,
"discount_distribution": "PER_DOCUMENT",
"discount_distribution_name": "Per Document",
"net_terms": "NET30",
"net_terms_name": "Net 30",
"has_late_fee": true,
"late_fee_kind": "PERCENTAGE",
"late_fee_kind_name": "Percentage",
"late_fee_interval": "ONE_TIME",
"late_fee_interval_name": "One Time",
"late_fee": 5,
"next_late_fee_update_at": "2023-11-07T05:31:56Z",
"total_late_fee": 0,
"shipping": 15,
"total": 1642.5,
"total_paid": 0,
"total_due": 1642.5,
"total_due_unsettled": 1642.5,
"notes": "Payment due within 30 days.",
"options": {},
"status": "DRAFT",
"status_name": "Draft",
"is_editable": true,
"issued_at": "2023-06-15",
"due_at": "2023-07-15",
"client": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Acme Inc",
"email": "[email protected]",
"kind": "BUSINESS",
"kind_name": "Business",
"profile": {
"company_name": "Acme Inc",
"website": "https://acme.com"
},
"address": {
"line1": "123 Main St",
"line2": "Suite 101",
"city": "San Francisco",
"state": "CA",
"zip": "94107",
"country": "US"
},
"document_defaults": {
"currency": "USD"
},
"contact_count": 3,
"note_count": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"organization": {
"id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Acme Inc",
"stripe_id": "<string>",
"subscription": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trial_ends_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"profile": {},
"role": "OWNER",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"line_items": [
{
"id": "01jtbf0c9zaraqx3swthf88n5y",
"organization_id": "01jtbf0c9zaraqx3swthf88n5y",
"name": "Consulting Services",
"description": "Professional consulting services",
"quantity": 10,
"price": 150,
"unit_of_measurement_id": "01jtbf0c9zaraqx3swthf88n5y",
"unit_name": "Hour",
"tax_id": "01jtbf0c9zaraqx3swthf88n5y",
"tax_name": "Sales Tax",
"tax_percent": 8.5,
"discount_type": "PERCENTAGE",
"discount_value": 10,
"subtotal": 1500,
"tax_amount": 127.5,
"total": 1627.5
}
],
"subtotal": 1500,
"document_discount": 0,
"tax_amount": 127.5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}{
"success": false,
"message": "Validation error",
"errors": {
"email": [
"The email field must be a valid email address."
]
}
}{
"success": false,
"message": "An error occurred",
"errors": {
"email": [
"The email field is required."
]
}
}Authorizations
Access token obtained from the /v1/auth/login endpoint
Body
application/json
Example:
"01jtbf0c9zaraqx3swthf88n5y"
Example:
"USD"
Example:
"PER_DOCUMENT"
Example:
"NO_DISCOUNT"
Example:
"NET30"
Show child attributes
Show child attributes
Example:
"01jtbf0c9zaraqx3swthf88n5y"
Example:
"PERCENTAGE"
Example:
10
Example:
true
Example:
"PERCENTAGE"
Example:
"ONE_TIME"
Example:
5
Example:
0
Example:
"Payment due within 30 days"
Example:
"2023-06-15"
⌘I