To accurately calculate sales tax, we need to know the category of the product you’re selling. We offer two ways to share this information, and you can select the approach that fits best with your business and integration needs. Early in your integration, you should make a decision to eitherDocumentation Index
Fetch the complete documentation index at: https://docs.numeral.com/llms.txt
Use this file to discover all available pages before exploring further.
- Categorize and register your products with Numeral
- Manage your product categories on your own
calculation endpoint differently.
If you categorize and register your products with Numeral, the line items you pass in will include a reference_product_id. We’ll use this product’s pre-registered category to ensure we return the correct amount of tax.
product_category with each line item. If you use this approach, we’ll use the category you give us to calculate the correct tax amount.
Option 1: Categorize and register your products with Numeral
If you take this approach, you’ll need to pre-register your products before you begin calculating tax on your sales. You’ll upload and categorize each of your products using the products endpoint. Taking this approach ensures that each product you sell has the correct category assigned to it, and that you don’t need to store tax categories in your system. You can just pass the same identifier you use in your existing system to eachcalculation API call as a reference_product_id.
Additionally, we’ll include the product’s details (like the product name, category and ID) on your filing reports, so you can more easily tie back these line items to the sales in your system.
When you introduce a new product, you’ll need to remember to upload it to Numeral before you begin selling it. If you pass in a reference_product_id we don’t recognize to the calculations endpoint, we will throw an error.
Option 2: Manage product categories on your own
If you take this approach, you can pass in a product category to thecalculations endpoint without registering the product with Numeral ahead of time.
This does mean that you’ll want to store the Numeral tax category with each product in your system so you can pass in the correct category. However, if you only sell one product or one category of product, you can just pass this category in with every calculation.
This approach also means you won’t need to register new products with Numeral before beginning sales, but you’ll need to ensure you categorize them appropriately in your system.