Retrieves the sale invoices.
curl --request GET \
--url https://api.example.com/api/sale-invoices \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/sale-invoices"
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-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.example.com/api/sale-invoices",
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-invoices"
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-invoices")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/sale-invoices")
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{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"invoiceDate": "2023-01-01T00:00:00Z",
"dueDate": "2023-01-15T00:00:00Z",
"invoiceNo": "INV-001",
"customerId": 1,
"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
}
],
"delivered": false,
"balance": 1000,
"paymentAmount": 500,
"subtotal": 900,
"total": 1000,
"dueAmount": 500,
"isOverdue": false,
"isPartiallyPaid": true,
"isFullyPaid": false,
"createdAt": "2023-01-01T00:00:00Z",
"referenceNo": "REF-001",
"exchangeRate": 1,
"currencyCode": "USD",
"invoiceMessage": "Thank you for your business",
"termsConditions": "Payment due within 14 days",
"isInclusiveTax": false,
"deliveredAt": "2023-01-02T00:00:00Z",
"warehouseId": 1,
"branchId": 1,
"projectId": 1,
"attachments": [
{}
],
"paymentMethods": [
{
"paymentIntegrationId": 1,
"enable": true
}
],
"discount": 10,
"discountType": "percentage",
"adjustment": 5,
"pdfTemplateId": 1,
"taxAmountWithheld": 50,
"creditedAmount": 0,
"updatedAt": "2023-01-02T00:00:00Z"
}
]
}Sale Invoices
Retrieves the sale invoices.
GET
/
api
/
sale-invoices
Retrieves the sale invoices.
curl --request GET \
--url https://api.example.com/api/sale-invoices \
--header 'Authorization: <authorization>' \
--header 'organization-id: <organization-id>'import requests
url = "https://api.example.com/api/sale-invoices"
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-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.example.com/api/sale-invoices",
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-invoices"
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-invoices")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/sale-invoices")
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{
"pagination": {
"total": 100,
"page": 1,
"pageSize": 10
},
"data": [
{
"id": 1,
"invoiceDate": "2023-01-01T00:00:00Z",
"dueDate": "2023-01-15T00:00:00Z",
"invoiceNo": "INV-001",
"customerId": 1,
"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
}
],
"delivered": false,
"balance": 1000,
"paymentAmount": 500,
"subtotal": 900,
"total": 1000,
"dueAmount": 500,
"isOverdue": false,
"isPartiallyPaid": true,
"isFullyPaid": false,
"createdAt": "2023-01-01T00:00:00Z",
"referenceNo": "REF-001",
"exchangeRate": 1,
"currencyCode": "USD",
"invoiceMessage": "Thank you for your business",
"termsConditions": "Payment due within 14 days",
"isInclusiveTax": false,
"deliveredAt": "2023-01-02T00:00:00Z",
"warehouseId": 1,
"branchId": 1,
"projectId": 1,
"attachments": [
{}
],
"paymentMethods": [
{
"paymentIntegrationId": 1,
"enable": true
}
],
"discount": 10,
"discountType": "percentage",
"adjustment": 5,
"pdfTemplateId": 1,
"taxAmountWithheld": 50,
"creditedAmount": 0,
"updatedAt": "2023-01-02T00:00:00Z"
}
]
}Headers
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
⌘I