The goal of the Numeral API is to help you collect and remit tax accurately. Additionally, we want to make sure you can easily map the activities in Numeral back to the systems your finance and fulfillment teams use every day. Throughout the Numeral API, you’ll see parameters designated to include reference IDs. They’ll have the structure reference_*_id - some examples include reference_product_id on the products endpoint and the the reference_order_id on the transactions endpoint. When you see one of these reference ID parameters, it’s a signal that you have an opportunity to map the action in Numeral to another action or object in another system. Whether tying order information back into your ERP, tracking down information for a specific customer, or scanning for orders including a specific product, these IDs can help you find the information needed to make Numeral work well with the rest of your financial platforms.
ParameterRelevant ObjectsUsage
reference_product_idproduct, calculationTie back sales and tax categories to your product catalog.
reference_order_idtransactionAssociate your orders and sales with Numeral transactions for reporting and reconciliation.
reference_line_item_idcalculationAssociate each line item to reporting and tax lines within Numeral. Particularly helpful for partial refunds.
reference_customer_idcustomer, calculationManage customer exemption status and tie orders to specific customers.