Get Started
Integration FAQs
Essentials
Calculations
Transactions
Transactions
Create Transactions
Record a completed sale
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Transaction response
The response is of type object
.
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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.