Sales Tax API
Core Concepts
Corporations
Calculate
Transactions
- Tax Transactions
- POSTCreate a transaction
- GETGet transaction
- GETList transactions
- DELDelete transaction
- Refund Transactions
- Bulk Transaction Import
Nexus
Registrations
Products
Customers
Exemption Certificates
List transactions
List all transactions that match this query
curl --request GET \
--url https://base_url/api/v1/transactions \
--header 'Authorization: Bearer <token>'
{
"data": {
"transactions": [
{
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"invoice_currency": "USD",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"transaction_status": "LOCKED",
"calculation_id": "<string>",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"source_platform": "RAZORPAY",
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE"
}
]
},
"exemption_type": "PURPOSE_RESALE",
"parent_invoice_id": "<string>"
}
],
"cursor": "<string>"
},
"message": "Successfully fetched transactions."
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The unique identifier of the corporation for which to retrieve data.
Cursor for pagination
Number of items to return per page
1 <= x <= 100
Response
The unique identifier for a transaction.
"2535af08-a139-4d0c-9827-1651e46dfbcf"
The unique identifier for the corporation associated with this transaction.
"b6d009b0-d174-463f-b030-94643c28e209"
ISO 8601 formatted date string indicating date on which the transaction took place.
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 4217 alpha-3 currency code for the transaction.
"USD"
Total amount before tax, shipping, handling, and discounts.
x >= 0
Total discount amount applied to the transaction.
x >= 0
0.99
Total shipping and handling charges.
x >= 0
This is the total amount charged to the customer, which includes the subtotal, shipping and handling fees, tax, and reflects any applied discounts.
x >= 0
Numeric value representing the amount of sales tax paid by the customer for this transaction.
x >= 0
Type of the transaction (sale or refund).
SALE
, REFUND
Status of the transaction. More details here.
LOCKED
, UNCOMMITTED
, IGNORED
ID of a previous calculation used for this transaction.
Either 5-digit ZIP code or 9-digit ZIP+4 code is accepted.
"90401"
2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.
"CA"
ISO 3166 2-letter country code. Ex: US, IN, GB.
"US"
"1776 Main St"
"Apt. #123"
"Santa Monica"
Unique identifier for the customer for this transaction.
External identifier for the customer.
Platform where this entity originated.
RAZORPAY
, ZOHO_BOOKS
, QUICKBOOKS_SANDBOX
, QUICKBOOKS
, XERO
, TALLY
, SAGE_CLOUD_ACCOUNTING
, MS_DYNAMICS_365
, SAGE_ZA_CLOUD_ACCOUNTING
, MYOB_BUSINESS
, WAVE
, ODOO_ACCOUNTING
, NETSUITE
, WAFEQ
, MEKARI_JURNAL
, BUSY
, ROOTFI_SANDBOX
, QOYOD
, SHOPIFY
, STRIPE
, PAYPAL
, HUBSPOT
, ZOHO_CRM
, PIPEDRIVE
, WOOCOMMERCE
, OTHER
Total price for the line item.
Quantity of units purchased.
Amount of tax collected for this line item.
The product taxability code for this line item.
Unique id in Commenda's system for the product being sold.
The SKU (Stock Keeping Unit) for the product.
If this field is present, this line item will be considered exempt.
PURPOSE_RESALE
, ENTITY_TYPE_NONPROFIT
, GOVERNMENT
, MANUFACTURER
, AGRICULTURAL
, OTHER
If this field is present, this transaction will be considered exempt.
PURPOSE_RESALE
, ENTITY_TYPE_NONPROFIT
, GOVERNMENT
, MANUFACTURER
, AGRICULTURAL
, OTHER
ID of the parent invoice, if this is a refund transaction.
Pagination cursor for the next set of results
"Successfully fetched transactions."
curl --request GET \
--url https://base_url/api/v1/transactions \
--header 'Authorization: Bearer <token>'
{
"data": {
"transactions": [
{
"id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
"corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
"transacted_at": "2023-12-25",
"tax_date_override": "2023-12-25",
"invoice_currency": "USD",
"subtotal": 1,
"discount": 0.99,
"shipping_and_handling": 1,
"total": 1,
"tax_collected": 1,
"transaction_type": "SALE",
"transaction_status": "LOCKED",
"calculation_id": "<string>",
"customer_details": {
"shipping_address": {
"address_line_1": "1776 Main St",
"address_line_2": "Apt. #123",
"address_line_3": "<string>",
"postal_code": "90401",
"city": "Santa Monica",
"state": "CA",
"country": "US"
},
"customer_id": "<string>",
"customer_external_id": "<string>"
},
"source_platform": "RAZORPAY",
"line_items": {
"items": [
{
"amount": 123,
"quantity": 123,
"tax_collected": 123,
"tax_code": "<string>",
"product_id": "<string>",
"product_sku": "<string>",
"exemption_type": "PURPOSE_RESALE"
}
]
},
"exemption_type": "PURPOSE_RESALE",
"parent_invoice_id": "<string>"
}
],
"cursor": "<string>"
},
"message": "Successfully fetched transactions."
}