POST
/
tax
/
transactions
curl --request POST \
  --url https://api.numeralhq.com/tax/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "calculation_id": "calc_123456789",
  "reference_order_id": "343-45836",
  "transaction_processed_at": 1714787673,
  "metadata": {
    "example_key": "example_value"
  }
}'
{
  "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": [
    {
      "product": {
        "reference_product_name": "Widget",
        "reference_line_item_id": "line_987654321",
        "reference_product_id": "p-1233543",
        "product_tax_code": "GENERAL_MERCHANDISE"
      },
      "tax_jurisdictions": [
        {
          "tax_rate": 0.07,
          "rate_type": "STATE SALES TAX",
          "jurisdiction_name": "Indiana",
          "fee_amount": 0
        }
      ],
      "quantity": 2,
      "tax_amount": 14,
      "amount_excluding_tax": 200,
      "amount_including_tax": 214
    }
  ],
  "testmode": "false",
  "metadata": {
    "example_key": "example_value"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
calculation_id
string
required

The ID of the calculation that you want to record as a sale

​
reference_order_id
string
required

The ID of this order in your system. Must be unique among all your transactions

​
transaction_processed_at
number

Unix timestamp in seconds representing the date and time your sale was made. If not provided, the current date and time will be used.

​
metadata
object

You can store arbitrary keys and values in the metadata. Any valid JSON object whose values are less than 255 characters long is accepted.

Response

200
application/json
Transaction response
​
id
string

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.

​
object
string

The type of object: tax.transaction.

​
calculation_id
string

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

​
reference_order_id
string

The unique order ID you provided when creating the transaction

​
transaction_processed_at
number

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_code
string

The ISO-4217 currency code of the transaction

​
filing_currency_code
string

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

​
line_items
object[]
​
testmode
boolean

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.

​
metadata
object

You can store arbitrary keys and values in the metadata. Any valid JSON object whose values are less than 255 characters long is accepted.

TransactionsCreate Refunds