Send invoice
curl --request POST \
--url https://app.blinksale.test/api/v1/invoices/{invoiceId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "Invoice INV-00001 from Acme Inc",
"message": "Please find the attached invoice. Payment is due on 2023-07-15.",
"send_to_client": true,
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"attach_pdf": true
}
'import requests
url = "https://app.blinksale.test/api/v1/invoices/{invoiceId}/send"
payload = {
"subject": "Invoice INV-00001 from Acme Inc",
"message": "Please find the attached invoice. Payment is due on 2023-07-15.",
"send_to_client": True,
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"attach_pdf": True
}
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({
subject: 'Invoice INV-00001 from Acme Inc',
message: 'Please find the attached invoice. Payment is due on 2023-07-15.',
send_to_client: true,
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
attach_pdf: true
})
};
fetch('https://app.blinksale.test/api/v1/invoices/{invoiceId}/send', 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/{invoiceId}/send",
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([
'subject' => 'Invoice INV-00001 from Acme Inc',
'message' => 'Please find the attached invoice. Payment is due on 2023-07-15.',
'send_to_client' => true,
'contact_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'attach_pdf' => true
]),
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/{invoiceId}/send"
payload := strings.NewReader("{\n \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\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/{invoiceId}/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinksale.test/api/v1/invoices/{invoiceId}/send")
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 \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invoice sent 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"
},
"count": 2
}{
"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": "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
Send Invoice
Send an invoice to recipients
POST
/
v1
/
invoices
/
{invoiceId}
/
send
Send invoice
curl --request POST \
--url https://app.blinksale.test/api/v1/invoices/{invoiceId}/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "Invoice INV-00001 from Acme Inc",
"message": "Please find the attached invoice. Payment is due on 2023-07-15.",
"send_to_client": true,
"contact_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"attach_pdf": true
}
'import requests
url = "https://app.blinksale.test/api/v1/invoices/{invoiceId}/send"
payload = {
"subject": "Invoice INV-00001 from Acme Inc",
"message": "Please find the attached invoice. Payment is due on 2023-07-15.",
"send_to_client": True,
"contact_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"attach_pdf": True
}
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({
subject: 'Invoice INV-00001 from Acme Inc',
message: 'Please find the attached invoice. Payment is due on 2023-07-15.',
send_to_client: true,
contact_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
attach_pdf: true
})
};
fetch('https://app.blinksale.test/api/v1/invoices/{invoiceId}/send', 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/{invoiceId}/send",
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([
'subject' => 'Invoice INV-00001 from Acme Inc',
'message' => 'Please find the attached invoice. Payment is due on 2023-07-15.',
'send_to_client' => true,
'contact_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'attach_pdf' => true
]),
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/{invoiceId}/send"
payload := strings.NewReader("{\n \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\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/{invoiceId}/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinksale.test/api/v1/invoices/{invoiceId}/send")
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 \"subject\": \"Invoice INV-00001 from Acme Inc\",\n \"message\": \"Please find the attached invoice. Payment is due on 2023-07-15.\",\n \"send_to_client\": true,\n \"contact_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"attach_pdf\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invoice sent 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"
},
"count": 2
}{
"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": "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
Path Parameters
The ID of the invoice to send
Body
application/json
⌘I