Create a quotation
curl --request POST \
--url https://{host}/api/public/v1/quotations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": 123,
"document_date": "2023-12-25",
"currency": "<string>",
"items": [
{
"quantity": 123,
"is_enabled": true,
"product_id": 123,
"product_name": "<string>",
"product_description": "<string>",
"bundle_name": "<string>",
"unit_amount": 123
}
],
"addresses": {
"billing": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
},
"shipping": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
},
"document_due_date": "2023-12-25",
"document_number": "<string>",
"custom_taxes": [
123
],
"user_id": 123,
"work_id": 123,
"discount_code": "<string>",
"custom_discounts": [
{
"name": "<string>",
"discount_type": "<string>",
"amount": 123,
"description": "<string>"
}
],
"is_use_shipping": true,
"payment_terms": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://{host}/api/public/v1/quotations"
payload = {
"contact_id": 123,
"document_date": "2023-12-25",
"currency": "<string>",
"items": [
{
"quantity": 123,
"is_enabled": True,
"product_id": 123,
"product_name": "<string>",
"product_description": "<string>",
"bundle_name": "<string>",
"unit_amount": 123
}
],
"addresses": {
"billing": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
},
"shipping": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
},
"document_due_date": "2023-12-25",
"document_number": "<string>",
"custom_taxes": [123],
"user_id": 123,
"work_id": 123,
"discount_code": "<string>",
"custom_discounts": [
{
"name": "<string>",
"discount_type": "<string>",
"amount": 123,
"description": "<string>"
}
],
"is_use_shipping": True,
"payment_terms": "<string>",
"remarks": "<string>"
}
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({
contact_id: 123,
document_date: '2023-12-25',
currency: '<string>',
items: [
{
quantity: 123,
is_enabled: true,
product_id: 123,
product_name: '<string>',
product_description: '<string>',
bundle_name: '<string>',
unit_amount: 123
}
],
addresses: {
billing: {
attention: '<string>',
email: 'jsmith@example.com',
company_name: '<string>',
mobile_no: '<string>',
office_no: '<string>',
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postcode: '<string>',
country: '<string>'
},
shipping: {
attention: '<string>',
email: 'jsmith@example.com',
company_name: '<string>',
mobile_no: '<string>',
office_no: '<string>',
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postcode: '<string>',
country: '<string>'
}
},
document_due_date: '2023-12-25',
document_number: '<string>',
custom_taxes: [123],
user_id: 123,
work_id: 123,
discount_code: '<string>',
custom_discounts: [
{
name: '<string>',
discount_type: '<string>',
amount: 123,
description: '<string>'
}
],
is_use_shipping: true,
payment_terms: '<string>',
remarks: '<string>'
})
};
fetch('https://{host}/api/public/v1/quotations', 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://{host}/api/public/v1/quotations",
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([
'contact_id' => 123,
'document_date' => '2023-12-25',
'currency' => '<string>',
'items' => [
[
'quantity' => 123,
'is_enabled' => true,
'product_id' => 123,
'product_name' => '<string>',
'product_description' => '<string>',
'bundle_name' => '<string>',
'unit_amount' => 123
]
],
'addresses' => [
'billing' => [
'attention' => '<string>',
'email' => 'jsmith@example.com',
'company_name' => '<string>',
'mobile_no' => '<string>',
'office_no' => '<string>',
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'country' => '<string>'
],
'shipping' => [
'attention' => '<string>',
'email' => 'jsmith@example.com',
'company_name' => '<string>',
'mobile_no' => '<string>',
'office_no' => '<string>',
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'country' => '<string>'
]
],
'document_due_date' => '2023-12-25',
'document_number' => '<string>',
'custom_taxes' => [
123
],
'user_id' => 123,
'work_id' => 123,
'discount_code' => '<string>',
'custom_discounts' => [
[
'name' => '<string>',
'discount_type' => '<string>',
'amount' => 123,
'description' => '<string>'
]
],
'is_use_shipping' => true,
'payment_terms' => '<string>',
'remarks' => '<string>'
]),
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://{host}/api/public/v1/quotations"
payload := strings.NewReader("{\n \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\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://{host}/api/public/v1/quotations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/public/v1/quotations")
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 \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"document_type": "invoice",
"document_number": "<string>",
"document_date": "<string>",
"document_due_date": "<string>",
"status": "<string>",
"status_name": "<string>",
"currency": "<string>",
"contact": {
"id": 123,
"contact_number": "<string>",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"lifecycle_stage": "lead",
"status": "<string>",
"status_name": "<string>",
"user": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"groups": [
{}
],
"primary_address": {
"id": 123,
"name": "<string>",
"attention": "<string>",
"email": "<string>",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"country_name": "<string>",
"zone_id": 123,
"is_primary": true
},
"works_count": 123,
"quotations_count": 123,
"invoices_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
},
"sub_total": 123,
"total_discount": 123,
"total_tax": 123,
"total_amount": 123,
"final_amount": 123,
"amount_paid": 123,
"remaining_amount": 123,
"pdf_url": "<string>",
"remarks": "<string>",
"items": [
{}
],
"taxes": [
{}
],
"discounts": [
{}
],
"addresses": {
"billing": {},
"shipping": {}
},
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is invalid, revoked, or expired."
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key does not have the required scope."
}
}{
"error": {
"code": "validation_failed",
"message": "The attention field is required.",
"fields": {
"attention": [
"The attention field is required."
]
}
}
}Quotations
Create a quotation
Creates a draft quotation. The request body is the same as for an invoice, without work_id.
Requires the documents:write scope.
POST
/
quotations
Create a quotation
curl --request POST \
--url https://{host}/api/public/v1/quotations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": 123,
"document_date": "2023-12-25",
"currency": "<string>",
"items": [
{
"quantity": 123,
"is_enabled": true,
"product_id": 123,
"product_name": "<string>",
"product_description": "<string>",
"bundle_name": "<string>",
"unit_amount": 123
}
],
"addresses": {
"billing": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
},
"shipping": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
},
"document_due_date": "2023-12-25",
"document_number": "<string>",
"custom_taxes": [
123
],
"user_id": 123,
"work_id": 123,
"discount_code": "<string>",
"custom_discounts": [
{
"name": "<string>",
"discount_type": "<string>",
"amount": 123,
"description": "<string>"
}
],
"is_use_shipping": true,
"payment_terms": "<string>",
"remarks": "<string>"
}
'import requests
url = "https://{host}/api/public/v1/quotations"
payload = {
"contact_id": 123,
"document_date": "2023-12-25",
"currency": "<string>",
"items": [
{
"quantity": 123,
"is_enabled": True,
"product_id": 123,
"product_name": "<string>",
"product_description": "<string>",
"bundle_name": "<string>",
"unit_amount": 123
}
],
"addresses": {
"billing": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
},
"shipping": {
"attention": "<string>",
"email": "jsmith@example.com",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>"
}
},
"document_due_date": "2023-12-25",
"document_number": "<string>",
"custom_taxes": [123],
"user_id": 123,
"work_id": 123,
"discount_code": "<string>",
"custom_discounts": [
{
"name": "<string>",
"discount_type": "<string>",
"amount": 123,
"description": "<string>"
}
],
"is_use_shipping": True,
"payment_terms": "<string>",
"remarks": "<string>"
}
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({
contact_id: 123,
document_date: '2023-12-25',
currency: '<string>',
items: [
{
quantity: 123,
is_enabled: true,
product_id: 123,
product_name: '<string>',
product_description: '<string>',
bundle_name: '<string>',
unit_amount: 123
}
],
addresses: {
billing: {
attention: '<string>',
email: 'jsmith@example.com',
company_name: '<string>',
mobile_no: '<string>',
office_no: '<string>',
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postcode: '<string>',
country: '<string>'
},
shipping: {
attention: '<string>',
email: 'jsmith@example.com',
company_name: '<string>',
mobile_no: '<string>',
office_no: '<string>',
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postcode: '<string>',
country: '<string>'
}
},
document_due_date: '2023-12-25',
document_number: '<string>',
custom_taxes: [123],
user_id: 123,
work_id: 123,
discount_code: '<string>',
custom_discounts: [
{
name: '<string>',
discount_type: '<string>',
amount: 123,
description: '<string>'
}
],
is_use_shipping: true,
payment_terms: '<string>',
remarks: '<string>'
})
};
fetch('https://{host}/api/public/v1/quotations', 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://{host}/api/public/v1/quotations",
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([
'contact_id' => 123,
'document_date' => '2023-12-25',
'currency' => '<string>',
'items' => [
[
'quantity' => 123,
'is_enabled' => true,
'product_id' => 123,
'product_name' => '<string>',
'product_description' => '<string>',
'bundle_name' => '<string>',
'unit_amount' => 123
]
],
'addresses' => [
'billing' => [
'attention' => '<string>',
'email' => 'jsmith@example.com',
'company_name' => '<string>',
'mobile_no' => '<string>',
'office_no' => '<string>',
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'country' => '<string>'
],
'shipping' => [
'attention' => '<string>',
'email' => 'jsmith@example.com',
'company_name' => '<string>',
'mobile_no' => '<string>',
'office_no' => '<string>',
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postcode' => '<string>',
'country' => '<string>'
]
],
'document_due_date' => '2023-12-25',
'document_number' => '<string>',
'custom_taxes' => [
123
],
'user_id' => 123,
'work_id' => 123,
'discount_code' => '<string>',
'custom_discounts' => [
[
'name' => '<string>',
'discount_type' => '<string>',
'amount' => 123,
'description' => '<string>'
]
],
'is_use_shipping' => true,
'payment_terms' => '<string>',
'remarks' => '<string>'
]),
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://{host}/api/public/v1/quotations"
payload := strings.NewReader("{\n \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\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://{host}/api/public/v1/quotations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/public/v1/quotations")
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 \"contact_id\": 123,\n \"document_date\": \"2023-12-25\",\n \"currency\": \"<string>\",\n \"items\": [\n {\n \"quantity\": 123,\n \"is_enabled\": true,\n \"product_id\": 123,\n \"product_name\": \"<string>\",\n \"product_description\": \"<string>\",\n \"bundle_name\": \"<string>\",\n \"unit_amount\": 123\n }\n ],\n \"addresses\": {\n \"billing\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"shipping\": {\n \"attention\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"company_name\": \"<string>\",\n \"mobile_no\": \"<string>\",\n \"office_no\": \"<string>\",\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\"\n }\n },\n \"document_due_date\": \"2023-12-25\",\n \"document_number\": \"<string>\",\n \"custom_taxes\": [\n 123\n ],\n \"user_id\": 123,\n \"work_id\": 123,\n \"discount_code\": \"<string>\",\n \"custom_discounts\": [\n {\n \"name\": \"<string>\",\n \"discount_type\": \"<string>\",\n \"amount\": 123,\n \"description\": \"<string>\"\n }\n ],\n \"is_use_shipping\": true,\n \"payment_terms\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"document_type": "invoice",
"document_number": "<string>",
"document_date": "<string>",
"document_due_date": "<string>",
"status": "<string>",
"status_name": "<string>",
"currency": "<string>",
"contact": {
"id": 123,
"contact_number": "<string>",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"lifecycle_stage": "lead",
"status": "<string>",
"status_name": "<string>",
"user": {
"id": 123,
"name": "<string>",
"email": "<string>"
},
"groups": [
{}
],
"primary_address": {
"id": 123,
"name": "<string>",
"attention": "<string>",
"email": "<string>",
"company_name": "<string>",
"mobile_no": "<string>",
"office_no": "<string>",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postcode": "<string>",
"country": "<string>",
"country_name": "<string>",
"zone_id": 123,
"is_primary": true
},
"works_count": 123,
"quotations_count": 123,
"invoices_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
},
"sub_total": 123,
"total_discount": 123,
"total_tax": 123,
"total_amount": 123,
"final_amount": 123,
"amount_paid": 123,
"remaining_amount": 123,
"pdf_url": "<string>",
"remarks": "<string>",
"items": [
{}
],
"taxes": [
{}
],
"discounts": [
{}
],
"addresses": {
"billing": {},
"shipping": {}
},
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is invalid, revoked, or expired."
}
}{
"error": {
"code": "insufficient_scope",
"message": "This API key does not have the required scope."
}
}{
"error": {
"code": "validation_failed",
"message": "The attention field is required.",
"fields": {
"attention": [
"The attention field is required."
]
}
}
}Authorizations
An API key created in BeanRails, for example brk_live_....
Body
application/json
A currency code set up in the workspace, for example MYR.
all applies every tax, none applies no tax and custom applies the taxes in custom_taxes.
Available options:
all, none, custom Minimum array length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required only when the workspace does not number documents automatically.
Tax IDs. Required when tax_selection is custom.
The user to assign the document to. Defaults to the key owner. Changing it needs the assign_user permission.
Invoices only. Links the invoice to a work that has no invoice yet.
Show child attributes
Show child attributes
When false, the billing address is also used for shipping.
Response
The created quotation.
Show child attributes
Show child attributes