Get Transaction

Changed on Nov 3, 2026

Retrieve the details of a specific transaction

get/tax/transactions/{transaction_id}

Request

Base URL
https://api.numeralhq.com
URL
https://api.numeralhq.com/tax/transactions/{transaction_id}
Auth
HTTP bearer

Path parameters

transaction_idstring required

Response

Transaction details

idstring

The ID of the transaction. We highly recommend you store this value. If you need to refund or query the data from this transaction, you will use this ID as a reference.

objectstring

The type of object: tax.transaction.

calculation_idstring

The ID of the calculation that was used to create this transaction

reference_order_idstring

The unique order ID you provided when creating the transaction

transaction_processed_atnumber

Unix timestamp in seconds representing the date and time your sale was made. If not provided, the date and time this transaction was created

customer_currency_codestring

The ISO-4217 currency code of the transaction

filing_currency_codestring

The currency code of the filing that will be used to remit taxes collected on this transaction

testmodeboolean

True if using a production API key. If true, Numeral will record this transaction towards your nexus totals. If you're registered and collecting in the relevant jurisdiction, we'll file the tax.

Example response

{
  "id": "tr_123456789",
  "object": "tax.transaction",
  "calculation_id": "calc_123456789",
  "reference_order_id": "343-45836",
  "transaction_processed_at": 1714787673,
  "customer_currency_code": "USD",
  "filing_currency_code": "USD",
  "line_items": [
    {
      "line_item_id": "li_1783369661107e97b4af5-b61a-487d-aa31-ecee6e616f7f",
      "product": {
        "reference_product_name": "Red Shoes",
        "reference_line_item_id": "line_123456789",
        "reference_product_id": "p-1233543",
        "product_tax_code": "GENERAL_MERCHANDISE"
      },
      "tax_jurisdictions": [
        {
          "tax_rate": 0.07,
          "tax_due_decimal": 724.9275,
          "rate_type": "GENERAL STATE SALES TAX",
          "tax_authority_name": "Tennessee",
          "tax_type": "SALES"
        }
      ],
      "quantity": 2,
      "tax_amount": 14,
      "amount_excluding_tax": 200,
      "amount_including_tax": 214
    }
  ],
  "metadata": {
    "example_key": "example_value"
  }
}

Changes

Nov 3, 2026f4650eaed11f Revision changes
- breaking
  the // response's property format changed from int32 to no format for status
- breaking
  the // response's property format changed from int32 to no format for status
- breaking
  the // response's property format changed from int32 to no format for status
- breaking
  the // response's property format changed from int32 to no format for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id getTransaction_v20260301 was added
- info
  added the optional property // to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history