Get transaction

Get one transaction

curl --request GET \
  --url https://base_url/api/v1/transactions/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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": {
        "postal_code": "90401",
        "state": "CA",
        "country": "US",
        "address_line_1": "1776 Main St",
        "address_line_2": "Apt. #123",
        "address_line_3": "<string>",
        "city": "Santa Monica"
      },
      "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>"
  },
  "message": "Successfully fetched transaction."
}

GET

transactions

{id}

Get one transaction

curl --request GET \
  --url https://base_url/api/v1/transactions/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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": {
        "postal_code": "90401",
        "state": "CA",
        "country": "US",
        "address_line_1": "1776 Main St",
        "address_line_2": "Apt. #123",
        "address_line_3": "<string>",
        "city": "Santa Monica"
      },
      "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>"
  },
  "message": "Successfully fetched transaction."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The unique identifier of the transaction to fetch.

Response

Transaction fetch response

data

object

Show child attributes

data.id

string

The unique identifier for a transaction.

Example:

"2535af08-a139-4d0c-9827-1651e46dfbcf"

data.corporation_id

string

The unique identifier for the corporation associated with this transaction.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

data.transacted_at

string<date>

ISO 8601 formatted date string indicating date on which the transaction took place.

data.tax_date_override

string<date>

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.

data.invoice_currency

string

ISO 4217 alpha-3 currency code for the transaction.

Example:

"USD"

data.subtotal

number<float>

Total amount before tax, shipping, handling, and discounts.

Required range: x >= 0

data.discount

number<float>

Total discount amount applied to the transaction.

Required range: x >= 0

Example:

0.99

data.shipping_and_handling

number<float>

Total shipping and handling charges.

Required range: x >= 0

data.total

number<float>

This 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 >= 0

data.tax_collected

number<float>

Numeric value representing the amount of sales tax paid by the customer for this transaction.

Required range: x >= 0

data.transaction_type

enum<string>

Type of the transaction (sale or refund).

Available options:

SALE,

RETURN,

REFUND

data.transaction_status

enum<string>

Status of the transaction. More details here.

Available options:

LOCKED,

UNCOMMITTED,

IGNORED

data.calculation_id

string

ID of a previous calculation used for this transaction.

data.customer_details

object

Show child attributes

data.customer_details.shipping_address

object

Show child attributes

data.customer_details.shipping_address.postal_code

string

required

Either 5-digit ZIP code or 9-digit ZIP+4 code is accepted.

Example:

"90401"

data.customer_details.shipping_address.state

string

required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

data.customer_details.shipping_address.country

string

required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

data.customer_details.shipping_address.address_line_1

string

Example:

"1776 Main St"

data.customer_details.shipping_address.address_line_2

string

Example:

"Apt. #123"

data.customer_details.shipping_address.address_line_3

string

data.customer_details.shipping_address.city

string

Example:

"Santa Monica"

data.customer_details.customer_id

string

Unique identifier for the customer for this transaction.

data.customer_details.customer_external_id

string

External identifier for the customer.

data.source_platform

enum<string>

Platform where this entity originated.

Available options:

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

data.line_items

object

Show child attributes

data.line_items.items

object[]

Show child attributes

data.line_items.items.amount

number<float>

Total price for the line item.

data.line_items.items.quantity

integer

Quantity of units purchased.

data.line_items.items.tax_collected

number<float>

Amount of tax collected for this line item.

data.line_items.items.tax_code

string

The product taxability code for this line item.

data.line_items.items.product_id

string

Unique id in Commenda's system for the product being sold.

data.line_items.items.product_sku

string

The SKU (Stock Keeping Unit) for the product.

data.line_items.items.exemption_type

enum<string>

If this field is present, this line item will be considered exempt.

Available options:

PURPOSE_RESALE,

ENTITY_TYPE_NONPROFIT,

GOVERNMENT,

MANUFACTURER,

AGRICULTURAL,

OTHER

data.exemption_type

enum<string>

If this field is present, this transaction will be considered exempt.

Available options:

PURPOSE_RESALE,

ENTITY_TYPE_NONPROFIT,

GOVERNMENT,

MANUFACTURER,

AGRICULTURAL,

OTHER

data.parent_invoice_id

string

ID of the parent invoice, if this is a refund transaction.

message

string

Example:

"Successfully fetched transaction."

Create a transaction List transactions

⌘I

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

Authorizations

Path Parameters

Response