Retrieves the sale estimates.
curl --request GET \
--url https://api.example.com/api/sale-estimates \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/sale-estimates"
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};
fetch('https://api.example.com/api/sale-estimates', 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.example.com/api/sale-estimates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"organization-id: <organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/sale-estimates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/sale-estimates")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/sale-estimates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
response = http.request(request)
puts response.read_body{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"userId": 42,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"data": [
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"userId": 42,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3
}
]
}Sale Estimates
Retrieves the sale estimates.
GET
/
api
/
sale-estimates
Retrieves the sale estimates.
curl --request GET \
--url https://api.example.com/api/sale-estimates \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/sale-estimates"
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};
fetch('https://api.example.com/api/sale-estimates', 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.example.com/api/sale-estimates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"organization-id: <organization-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/sale-estimates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/sale-estimates")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/sale-estimates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
response = http.request(request)
puts response.read_body{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"userId": 42,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"data": [
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"userId": 42,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3
}
]
}Headers
Response
200 - application/json
Sale estimates retrieved successfully
Email to send the estimate to
Example: