Create a transaction
curl --request POST \
--url https://api.prod.commenda.io/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"invoice_currency": "USD",
"customer_details": {
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"line_number": "<string>",
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
]
},
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"marketplace": "<string>",
"tax_included": true
}
'import requests
url = "https://api.prod.commenda.io/api/v1/transactions"
payload = {
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"invoice_currency": "USD",
"customer_details": {
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": { "items": [
{
"amount": 123,
"quantity": 123,
"line_number": "<string>",
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
] },
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"marketplace": "<string>",
"tax_included": 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({
corporation_id: 'b6d009b0-d174-463f-b030-94643c28e209',
transacted_at: '2023-12-25',
invoice_currency: 'USD',
customer_details: {customer_id: '<string>', customer_external_id: '<string>'},
line_items: {
items: [
{
amount: 123,
quantity: 123,
line_number: '<string>',
price_per_unit: 123,
discount_amount: 1,
tax_collected: 123,
tax_code: '<string>',
product_id: '<string>',
product_sku: '<string>',
exemption_reason: '<string>',
exemption_certificate_id: '<string>'
}
]
},
tax_date_override: '2023-12-25',
calculation_date_override: '2023-12-25',
reporting_date_override: '2023-12-25',
invoice_number: '<string>',
subtotal: 1,
discount: 0.99,
shipping_and_handling: 1,
total: 1,
tax_collected: 1,
calculation_id: '<string>',
parent_invoice_id: '<string>',
marketplace: '<string>',
tax_included: true
})
};
fetch('https://api.prod.commenda.io/api/v1/transactions', 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.prod.commenda.io/api/v1/transactions",
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([
'corporation_id' => 'b6d009b0-d174-463f-b030-94643c28e209',
'transacted_at' => '2023-12-25',
'invoice_currency' => 'USD',
'customer_details' => [
'customer_id' => '<string>',
'customer_external_id' => '<string>'
],
'line_items' => [
'items' => [
[
'amount' => 123,
'quantity' => 123,
'line_number' => '<string>',
'price_per_unit' => 123,
'discount_amount' => 1,
'tax_collected' => 123,
'tax_code' => '<string>',
'product_id' => '<string>',
'product_sku' => '<string>',
'exemption_reason' => '<string>',
'exemption_certificate_id' => '<string>'
]
]
],
'tax_date_override' => '2023-12-25',
'calculation_date_override' => '2023-12-25',
'reporting_date_override' => '2023-12-25',
'invoice_number' => '<string>',
'subtotal' => 1,
'discount' => 0.99,
'shipping_and_handling' => 1,
'total' => 1,
'tax_collected' => 1,
'calculation_id' => '<string>',
'parent_invoice_id' => '<string>',
'marketplace' => '<string>',
'tax_included' => 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://api.prod.commenda.io/api/v1/transactions"
payload := strings.NewReader("{\n \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": 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://api.prod.commenda.io/api/v1/transactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/transactions")
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 \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9753a999-6d64-4a4f-ad9b-345890d32722",
"corporation_id": "74df772f-9260-42cf-9c20-3b613b60fecd",
"transacted_at": "2025-11-30",
"created_at": 1765177896736899,
"reporting_date_override": "2025-11-30",
"invoice_currency": "USD",
"subtotal": 46.15,
"discount": 0,
"shipping_and_handling": 0,
"total": 48.09,
"tax_collected": 1.94,
"invoice_status": "LOCKED",
"invoice_type": "SALE",
"invoice_number": "c85100ab-7c61-4aa6-b207-c4dae0d40d13",
"creation_method": "TRANSACTIONS_API_BULK",
"marketplace": "<string>",
"metadata": {},
"customer_details": {
"shipping_address": {
"country": "US",
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA"
},
"customer_id": "<string>"
},
"line_items": {
"items": [
{
"id": "aec197ca-a1fa-4669-8496-f52c82da5d3c",
"amount": 46.15,
"quantity": 1,
"shipping": 0,
"handling": 0,
"discount": 0,
"price_per_unit": 46.15,
"tax_collected": 1.94,
"tax_code": "<string>",
"product_id": "<string>",
"exemption_certificate_id": "00000000-0000-0000-0000-000000000000"
}
]
}
},
"message": "Successfully created transaction."
}{
"error": {
"type": "CLIENT_INVALID_REQUEST_BODY",
"doc_url": "https://sales-tax-docs.commenda.io/",
"title": "Failed to validate the request body",
"detail": "<string>",
"status": 400,
"instance": "<string>",
"Errors": [
{
"details": "<string>",
"pointer": "<string>"
}
]
}
}Transactions
Create a transaction
Submit a completed transaction for processing and filing
POST
/
transactions
Create a transaction
curl --request POST \
--url https://api.prod.commenda.io/api/v1/transactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"invoice_currency": "USD",
"customer_details": {
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"line_number": "<string>",
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
]
},
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"marketplace": "<string>",
"tax_included": true
}
'import requests
url = "https://api.prod.commenda.io/api/v1/transactions"
payload = {
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"invoice_currency": "USD",
"customer_details": {
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"line_items": { "items": [
{
"amount": 123,
"quantity": 123,
"line_number": "<string>",
"price_per_unit": 123,
"discount_amount": 1,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_reason": "<string>",
"exemption_certificate_id": "<string>"
}
] },
"tax_date_override": "2023-12-25",
"calculation_date_override": "2023-12-25",
"reporting_date_override": "2023-12-25",
"invoice_number": "<string>",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"calculation_id": "<string>",
"parent_invoice_id": "<string>",
"marketplace": "<string>",
"tax_included": 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({
corporation_id: 'b6d009b0-d174-463f-b030-94643c28e209',
transacted_at: '2023-12-25',
invoice_currency: 'USD',
customer_details: {customer_id: '<string>', customer_external_id: '<string>'},
line_items: {
items: [
{
amount: 123,
quantity: 123,
line_number: '<string>',
price_per_unit: 123,
discount_amount: 1,
tax_collected: 123,
tax_code: '<string>',
product_id: '<string>',
product_sku: '<string>',
exemption_reason: '<string>',
exemption_certificate_id: '<string>'
}
]
},
tax_date_override: '2023-12-25',
calculation_date_override: '2023-12-25',
reporting_date_override: '2023-12-25',
invoice_number: '<string>',
subtotal: 1,
discount: 0.99,
shipping_and_handling: 1,
total: 1,
tax_collected: 1,
calculation_id: '<string>',
parent_invoice_id: '<string>',
marketplace: '<string>',
tax_included: true
})
};
fetch('https://api.prod.commenda.io/api/v1/transactions', 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.prod.commenda.io/api/v1/transactions",
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([
'corporation_id' => 'b6d009b0-d174-463f-b030-94643c28e209',
'transacted_at' => '2023-12-25',
'invoice_currency' => 'USD',
'customer_details' => [
'customer_id' => '<string>',
'customer_external_id' => '<string>'
],
'line_items' => [
'items' => [
[
'amount' => 123,
'quantity' => 123,
'line_number' => '<string>',
'price_per_unit' => 123,
'discount_amount' => 1,
'tax_collected' => 123,
'tax_code' => '<string>',
'product_id' => '<string>',
'product_sku' => '<string>',
'exemption_reason' => '<string>',
'exemption_certificate_id' => '<string>'
]
]
],
'tax_date_override' => '2023-12-25',
'calculation_date_override' => '2023-12-25',
'reporting_date_override' => '2023-12-25',
'invoice_number' => '<string>',
'subtotal' => 1,
'discount' => 0.99,
'shipping_and_handling' => 1,
'total' => 1,
'tax_collected' => 1,
'calculation_id' => '<string>',
'parent_invoice_id' => '<string>',
'marketplace' => '<string>',
'tax_included' => 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://api.prod.commenda.io/api/v1/transactions"
payload := strings.NewReader("{\n \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": 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://api.prod.commenda.io/api/v1/transactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/transactions")
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 \"corporation_id\": \"b6d009b0-d174-463f-b030-94643c28e209\",\n \"transacted_at\": \"2023-12-25\",\n \"invoice_currency\": \"USD\",\n \"customer_details\": {\n \"customer_id\": \"<string>\",\n \"customer_external_id\": \"<string>\"\n },\n \"line_items\": {\n \"items\": [\n {\n \"amount\": 123,\n \"quantity\": 123,\n \"line_number\": \"<string>\",\n \"price_per_unit\": 123,\n \"discount_amount\": 1,\n \"tax_collected\": 123,\n \"tax_code\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_sku\": \"<string>\",\n \"exemption_reason\": \"<string>\",\n \"exemption_certificate_id\": \"<string>\"\n }\n ]\n },\n \"tax_date_override\": \"2023-12-25\",\n \"calculation_date_override\": \"2023-12-25\",\n \"reporting_date_override\": \"2023-12-25\",\n \"invoice_number\": \"<string>\",\n \"subtotal\": 1,\n \"discount\": 0.99,\n \"shipping_and_handling\": 1,\n \"total\": 1,\n \"tax_collected\": 1,\n \"calculation_id\": \"<string>\",\n \"parent_invoice_id\": \"<string>\",\n \"marketplace\": \"<string>\",\n \"tax_included\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9753a999-6d64-4a4f-ad9b-345890d32722",
"corporation_id": "74df772f-9260-42cf-9c20-3b613b60fecd",
"transacted_at": "2025-11-30",
"created_at": 1765177896736899,
"reporting_date_override": "2025-11-30",
"invoice_currency": "USD",
"subtotal": 46.15,
"discount": 0,
"shipping_and_handling": 0,
"total": 48.09,
"tax_collected": 1.94,
"invoice_status": "LOCKED",
"invoice_type": "SALE",
"invoice_number": "c85100ab-7c61-4aa6-b207-c4dae0d40d13",
"creation_method": "TRANSACTIONS_API_BULK",
"marketplace": "<string>",
"metadata": {},
"customer_details": {
"shipping_address": {
"country": "US",
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA"
},
"customer_id": "<string>"
},
"line_items": {
"items": [
{
"id": "aec197ca-a1fa-4669-8496-f52c82da5d3c",
"amount": 46.15,
"quantity": 1,
"shipping": 0,
"handling": 0,
"discount": 0,
"price_per_unit": 46.15,
"tax_collected": 1.94,
"tax_code": "<string>",
"product_id": "<string>",
"exemption_certificate_id": "00000000-0000-0000-0000-000000000000"
}
]
}
},
"message": "Successfully created transaction."
}{
"error": {
"type": "CLIENT_INVALID_REQUEST_BODY",
"doc_url": "https://sales-tax-docs.commenda.io/",
"title": "Failed to validate the request body",
"detail": "<string>",
"status": 400,
"instance": "<string>",
"Errors": [
{
"details": "<string>",
"pointer": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The unique identifier for the corporation associated with this transaction.
Example:
"b6d009b0-d174-463f-b030-94643c28e209"
ISO 8601 formatted date string indicating date on which the transaction took place.
ISO 4217 alpha-3 currency code for the transaction.
Example:
"USD"
Type of the transaction. Accepted values for creation: SALE or PURCHASE.
SALE: Standard sales transaction.PURCHASE: Purchase transaction for input tax credit tracking.RETURN,REFUND, andPURCHASE_REFUNDtypes are created via the refund endpoint.
Available options:
SALE, RETURN, REFUND, PURCHASE, PURCHASE_REFUND Show child attributes
Show child attributes
Show child attributes
Show child attributes
ISO 8601 formatted date string indicating the date on which the tax liability should be recognized for filings and for nexus tracking, if different from the transacted_at date.
ISO 8601 formatted date string indicating the date to use for tax rate lookups, useful for ensuring returns use the same rates as the original sale.
ISO 8601 formatted date string indicating when this transaction should appear in reports, if different from transacted_at.
Invoice or receipt number for this transaction.
Total amount before tax, shipping, handling, and discounts.
Required range:
x >= 0Total discount amount applied to the transaction.
Required range:
x >= 0Example:
0.99
Total shipping and handling charges.
Required range:
x >= 0This is the total amount charged to the customer, which includes the subtotal, shipping and handling fees, tax, and reflects any applied discounts.
Required range:
x >= 0Numeric value representing the amount of sales tax paid by the customer for this transaction.
Required range:
x >= 0Optional ID of a previous calculation used for this transaction.
Required for RETURN transactions. The ID of the original sale transaction being returned. This links the return to the original sale for proper tax accounting.
Required for RETURN transactions. Specifies whether this is a full or partial return.
- FULL: The entire transaction amount is refunded
- PARTIAL: Only specific items or amounts are refunded
Available options:
FULL, PARTIAL Marketplace name if the transaction originates from a marketplace.
Indicates which party is responsible for remitting tax on the transaction.
- SELLER: The seller collects and remits tax (default).
- MARKETPLACE_FACILITATOR: A marketplace facilitator collects and remits tax on behalf of the seller.
- BUYER: The buyer is responsible for remitting tax (reverse-charge mechanism, common in B2B VAT transactions).
Available options:
SELLER, MARKETPLACE_FACILITATOR, BUYER Whether tax is included in the line item prices.
If this field is present, this transaction will be considered exempt.
Available options:
PURPOSE_RESALE, ENTITY_TYPE_NONPROFIT, GOVERNMENT, MANUFACTURER, AGRICULTURAL, EXEMPT_PRODUCT, OTHER, EXEMPT_PRODUCT Was this page helpful?
⌘I