Create standalone invoice
curl --request POST \
--url https://api.salesbricks.com/api/v2/invoices \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-12-25",
"line_items": [
{
"name": "<string>",
"unit_price": "<string>",
"quantity": 50000000000000,
"description": "",
"recognition_timing": "PERIOD_END"
}
],
"accounts_payable_emails": [
"jsmith@example.com"
],
"issued_at": "2023-12-25",
"invoice_memo": "<string>",
"purchase_order": {
"code": "<string>"
},
"send_invoice": false,
"pdf_attachments": [
"<string>"
],
"pdf_attachments_config": [
{}
],
"auto_pay_invoice": false,
"dunning_auto_retries": true,
"adjustments": [],
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"metadata": {},
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_partner_billed": false
}
'import requests
url = "https://api.salesbricks.com/api/v2/invoices"
payload = {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-12-25",
"line_items": [
{
"name": "<string>",
"unit_price": "<string>",
"quantity": 50000000000000,
"description": "",
"recognition_timing": "PERIOD_END"
}
],
"accounts_payable_emails": ["jsmith@example.com"],
"issued_at": "2023-12-25",
"invoice_memo": "<string>",
"purchase_order": { "code": "<string>" },
"send_invoice": False,
"pdf_attachments": ["<string>"],
"pdf_attachments_config": [{}],
"auto_pay_invoice": False,
"dunning_auto_retries": True,
"adjustments": [],
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"metadata": {},
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_partner_billed": False
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
due_at: '2023-12-25',
line_items: [
{
name: '<string>',
unit_price: '<string>',
quantity: 50000000000000,
description: '',
recognition_timing: 'PERIOD_END'
}
],
accounts_payable_emails: ['jsmith@example.com'],
issued_at: '2023-12-25',
invoice_memo: '<string>',
purchase_order: {code: '<string>'},
send_invoice: false,
pdf_attachments: ['<string>'],
pdf_attachments_config: [{}],
auto_pay_invoice: false,
dunning_auto_retries: true,
adjustments: [],
starts_at: '2023-12-25',
ends_at: '2023-12-25',
metadata: {},
partner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
is_partner_billed: false
})
};
fetch('https://api.salesbricks.com/api/v2/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://api.salesbricks.com/api/v2/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([
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'due_at' => '2023-12-25',
'line_items' => [
[
'name' => '<string>',
'unit_price' => '<string>',
'quantity' => 50000000000000,
'description' => '',
'recognition_timing' => 'PERIOD_END'
]
],
'accounts_payable_emails' => [
'jsmith@example.com'
],
'issued_at' => '2023-12-25',
'invoice_memo' => '<string>',
'purchase_order' => [
'code' => '<string>'
],
'send_invoice' => false,
'pdf_attachments' => [
'<string>'
],
'pdf_attachments_config' => [
[
]
],
'auto_pay_invoice' => false,
'dunning_auto_retries' => true,
'adjustments' => [
],
'starts_at' => '2023-12-25',
'ends_at' => '2023-12-25',
'metadata' => [
],
'partner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'is_partner_billed' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-KEY: <api-key>"
],
]);
$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.salesbricks.com/api/v2/invoices"
payload := strings.NewReader("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
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.salesbricks.com/api/v2/invoices")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}"
response = http.request(request)
puts response.read_body{
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"due_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Invoices
Create standalone invoice
Create a one-off invoice for a customer without a subscription.
POST
/
invoices
Create standalone invoice
curl --request POST \
--url https://api.salesbricks.com/api/v2/invoices \
--header 'Content-Type: application/json' \
--header 'X-SALESBRICKS-KEY: <api-key>' \
--data '
{
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-12-25",
"line_items": [
{
"name": "<string>",
"unit_price": "<string>",
"quantity": 50000000000000,
"description": "",
"recognition_timing": "PERIOD_END"
}
],
"accounts_payable_emails": [
"jsmith@example.com"
],
"issued_at": "2023-12-25",
"invoice_memo": "<string>",
"purchase_order": {
"code": "<string>"
},
"send_invoice": false,
"pdf_attachments": [
"<string>"
],
"pdf_attachments_config": [
{}
],
"auto_pay_invoice": false,
"dunning_auto_retries": true,
"adjustments": [],
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"metadata": {},
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_partner_billed": false
}
'import requests
url = "https://api.salesbricks.com/api/v2/invoices"
payload = {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"due_at": "2023-12-25",
"line_items": [
{
"name": "<string>",
"unit_price": "<string>",
"quantity": 50000000000000,
"description": "",
"recognition_timing": "PERIOD_END"
}
],
"accounts_payable_emails": ["jsmith@example.com"],
"issued_at": "2023-12-25",
"invoice_memo": "<string>",
"purchase_order": { "code": "<string>" },
"send_invoice": False,
"pdf_attachments": ["<string>"],
"pdf_attachments_config": [{}],
"auto_pay_invoice": False,
"dunning_auto_retries": True,
"adjustments": [],
"starts_at": "2023-12-25",
"ends_at": "2023-12-25",
"metadata": {},
"partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_partner_billed": False
}
headers = {
"X-SALESBRICKS-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SALESBRICKS-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
due_at: '2023-12-25',
line_items: [
{
name: '<string>',
unit_price: '<string>',
quantity: 50000000000000,
description: '',
recognition_timing: 'PERIOD_END'
}
],
accounts_payable_emails: ['jsmith@example.com'],
issued_at: '2023-12-25',
invoice_memo: '<string>',
purchase_order: {code: '<string>'},
send_invoice: false,
pdf_attachments: ['<string>'],
pdf_attachments_config: [{}],
auto_pay_invoice: false,
dunning_auto_retries: true,
adjustments: [],
starts_at: '2023-12-25',
ends_at: '2023-12-25',
metadata: {},
partner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
is_partner_billed: false
})
};
fetch('https://api.salesbricks.com/api/v2/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://api.salesbricks.com/api/v2/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([
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'due_at' => '2023-12-25',
'line_items' => [
[
'name' => '<string>',
'unit_price' => '<string>',
'quantity' => 50000000000000,
'description' => '',
'recognition_timing' => 'PERIOD_END'
]
],
'accounts_payable_emails' => [
'jsmith@example.com'
],
'issued_at' => '2023-12-25',
'invoice_memo' => '<string>',
'purchase_order' => [
'code' => '<string>'
],
'send_invoice' => false,
'pdf_attachments' => [
'<string>'
],
'pdf_attachments_config' => [
[
]
],
'auto_pay_invoice' => false,
'dunning_auto_retries' => true,
'adjustments' => [
],
'starts_at' => '2023-12-25',
'ends_at' => '2023-12-25',
'metadata' => [
],
'partner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'is_partner_billed' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SALESBRICKS-KEY: <api-key>"
],
]);
$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.salesbricks.com/api/v2/invoices"
payload := strings.NewReader("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SALESBRICKS-KEY", "<api-key>")
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.salesbricks.com/api/v2/invoices")
.header("X-SALESBRICKS-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesbricks.com/api/v2/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SALESBRICKS-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"due_at\": \"2023-12-25\",\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"unit_price\": \"<string>\",\n \"quantity\": 50000000000000,\n \"description\": \"\",\n \"recognition_timing\": \"PERIOD_END\"\n }\n ],\n \"accounts_payable_emails\": [\n \"jsmith@example.com\"\n ],\n \"issued_at\": \"2023-12-25\",\n \"invoice_memo\": \"<string>\",\n \"purchase_order\": {\n \"code\": \"<string>\"\n },\n \"send_invoice\": false,\n \"pdf_attachments\": [\n \"<string>\"\n ],\n \"pdf_attachments_config\": [\n {}\n ],\n \"auto_pay_invoice\": false,\n \"dunning_auto_retries\": true,\n \"adjustments\": [],\n \"starts_at\": \"2023-12-25\",\n \"ends_at\": \"2023-12-25\",\n \"metadata\": {},\n \"partner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_partner_billed\": false\n}"
response = http.request(request)
puts response.read_body{
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"amount": 123,
"currency": "<string>",
"status": "<string>",
"due_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "ERR_NOT_FOUND",
"message": "<string>",
"error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
API key for authentication
Body
application/jsonmultipart/form-dataapplication/x-www-form-urlencoded
Input serializer for POST /api/v2/invoices.
The unique identifier of the customer to whom the invoice is being sent
The date on which the invoice is due
Optional currency to be used for the subscription. Defaults to USD.
USD- United States DollarEUR- EurosGBP- Great British PoundAUD- Australian DollarCAD- Canadian DollarINR- Indian Rupee
Available options:
USD, EUR, GBP, AUD, CAD, INR The line items to be included on the invoice
Show child attributes
Show child attributes
List of accounts payable contact emails for the invoice
The date on which this invoice was issued. Defaults to today.
Optional memo or notes to be included on the invoice
Maximum string length:
2000Optional purchase order number to be included on the invoice
Show child attributes
Show child attributes
Whether to send the invoice to the customer after creating it
PDF files to attach to the invoice
Configuration for managing attachments. Each item specifies a new file to add (by new_file_index) or a terms document to attach (by terms_document_id). The order in this array determines the unified order of attachments in the PDF. If omitted, pdf_attachments are attached in upload order.
Show child attributes
Show child attributes
('Decides wether to charge when this invoice is issued or when it is due if auto-pay is enabled. ', 'ISSUE_DATE - Charge when the invoice is issued. ', 'DUE_DATE - Charge when the invoice is due if auto-pay is enabled.')
ISSUE_DATE- Charge on issue dateDUE_DATE- Charge on due dateORDER_FORM_ONLY_DUE_DATE- Charge on due date (order form only)
Available options:
ISSUE_DATE, DUE_DATE, ORDER_FORM_ONLY_DUE_DATE, ('Whether to enable auto pay when the invoice is generated. This gives ability to auto-charge the ', "invoice when there's a saved payment method to be used. Defaults to False.")
Whether to enable automatic retries for failed payments. When enabled, failed invoice payments will be retried using saved payment methods. Defaults to False.
Optional adjustments to be included on the invoice
Show child attributes
Show child attributes
Optional service period start date. Defaults to today's date if not provided.
Optional service period end date. Defaults to today's date + 1 month if not provided.
Optional metadata to add to the invoice. Keys prefixed with _ are private and will be ignored.
Show child attributes
Show child attributes
Optional ID of the Partner involved in this invoice. Attaching a partner records who sourced the deal; it does not move the money unless is_partner_billed is also set. Requires the PARTNERS feature.
Whether the partner named by partner_id is billed instead of the customer. The customer stays the buyer either way. Defaults to False, which bills the customer.
Response
Response serializer for POST /api/v2/invoices.
The unique identifier of the created invoice
Short form identifier for the invoice.
The total amount to be charged for this invoice.
The currency in which the invoice is denominated (e.g., USD, EUR).
Current status of the invoice. One of:
MUTED— Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings.SCHEDULED— Scheduled to be issued on a future date.OUTSTANDING— Issued and awaiting payment.DUE— Payment is due.PAST_DUE— Payment is past its due date.PAID— Fully paid.PARTIALLY_PAID— Partially paid, with a remaining balance.ADJUSTED— Adjusted after issuance.CREDITED— Settled by applying credit.UNPAID— Unpaid.PAUSED— Collection is paused.VOIDED— Voided and no longer collectible.
The date on which this invoice is expected to be paid by.