Create Calculations

Get tax information for a given product and address

Authorizations

Authorization

string

header

required

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

Body

application/json

customer

object

required

Customer details. Address is required. Optionally accepts a customer ID for order tracking and exemptions.

Show child attributes

customer.address

object

required

Show child attributes

customer.address.address_line_1

string

required

customer.address.address_city

string

required

customer.address.address_province

string

required

The province of the transaction. Must be a valid 2 digit ISO 3166-2 province code.

customer.address.address_postal_code

string

required

customer.address.address_country

string

required

The country code of the transaction. Must be a valid ISO 3166-1 alpha-2 country code.

customer.address.address_type

string

required

The type of address. Must be one of: shipping or billing. For physical goods, shipping should be used. For software and digital goods, billing is more appropriate

customer.address.address_line_2

string

customer.id

string

The ID of the customer that you created in our system. Can be used to log customer information or indicate that a purchaser is tax exempt. For more, see Creating a Customer.

order_details

object

required

Show child attributes

order_details.customer_currency_code

string

required

The currency code of the transaction. Must be either 'USD' or 'CAD'.

order_details.tax_included_in_amount

boolean

required

This should almost always be false for sales in the United States. For the line items in this transaction, does the amount include tax?

order_details.line_items

object[]

required

Each line item should represent one type of product. For compliance, we require either a reference_product_id or a product_category. See this guide for more.

Show child attributes

order_details.line_items.amount

number

required

The price of this line item. We will calculate tax against this value.

order_details.line_items.quantity

number

required

The quantity of this product being sold. Primarily used for record keeping.

order_details.line_items.reference_line_item_id

string

The ID of the line item from your system. This field is optional and will be primarily used for record keeping.

order_details.line_items.reference_product_id

string

The product ID is used to uniquely reference this product in your system as well as in Numeral. Required if no product_category.

order_details.line_items.product_category

string

A tax category from our category taxonomy. Required if no reference_product_id.

origin_address

object

Optional, but relevant for tax collection in certain states. The address that a product is shipped from.

Show child attributes

origin_address.address_line_1

string

required

origin_address.address_city

string

required

origin_address.address_province

string

required

The province of the transaction. Must be a valid 2 digit ISO 3166-2 province code.

origin_address.address_postal_code

string

required

origin_address.address_country

string

required

The country code of the transaction. Must be a valid ISO 3166-1 alpha-2 country code.

origin_address.address_line_2

string

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.

Show child attributes

metadata.example_key

string

Storing things like an order number may be useful for reporting and reconciliation.

Response

200

application/json

Calculate response

id

string

The ID of the calculation. You will use this to create a transaction.

object

string

The type of object: tax.calculation.

customer_currency_code

string

The ISO-4217 currency code of the transaction.

line_items

object[]

Show child attributes

line_items.product

object

Show child attributes

line_items.product.reference_product_name

string

line_items.product.reference_line_item_id

string

line_items.product.reference_product_id

string

line_items.product.product_tax_code

string

line_items.tax_jurisdictions

array

Show child attributes

line_items.tax_jurisdictions.tax_rate

number

The tax rate percentage applied to this transaction.

line_items.tax_jurisdictions.rate_type

string

line_items.tax_jurisdictions.jurisdiction_name

string

line_items.tax_jurisdictions.fee_amount

number

The flat fee that is added to this transaction. Like all numeric values, this will be returned in cents and should be added directly to the tax amount independent of other percentages. For example, a $100 transaction taxed at 5% and with a fee_amount: 50 will lead to ($100 * 5% + 0.50) = $5.50 in tax being charged

line_items.quantity

number

line_items.tax_amount

number

line_items.amount_excluding_tax

number

line_items.amount_including_tax

number

tax_included_in_amount

boolean

total_tax_amount

number

Total tax to charge on this calculation.

total_amount_excluding_tax

number

Total sale charge, excluding tax.

total_amount_including_tax

number

Total sale charge plus tax. What you should charge your customer.

expires_at

number

Epoch datetime representing the date and time the tax rates are valid until.

testmode

boolean

True if using a production API key. False if using a test API key.

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.

Show child attributes

metadata.example_key

string

Storing things like an order number may be useful for reporting and reconciliation.