Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.numeral.com/llms.txt

Use this file to discover all available pages before exploring further.

The Numeral Tax Provider for Acumatica is a customization project that registers Numeral as a tax engine. Once installed, every sales document that targets a Numeral-backed Tax Zone calls Numeral for real-time tax calculation, and posted documents are recorded back to Numeral as transactions.
This integration requires Acumatica ERP 2020 R2 or later and an Acumatica administrator account with rights to upload customization projects.

​
What you’ll do

  1. Import and publish the Numeral customization project
  2. Register the Numeral Tax Plugin
  3. Create a Tax Zone for Numeral and assign it to customers and branches
  4. Validate with a test sales order

​
1. Import the customization project

Numeral provides a .zip customization project file.
  1. Open Customization Projects (SM204505)
  2. Click Import and select the .zip file
  3. Select the imported project and click Publish → Publish Current Project
Acumatica will compile and register the Numeral tax provider classes. The publish step typically takes 1–3 minutes.

​
2. Register the Numeral Tax Plugin

Open Tax Plugins (TX102000) and add a new plugin row.
FieldValue
Plugin IDNUMERAL
DescriptionNumeral Tax Provider
Plugin TypeNumeralConnector.TaxProvider.NumeralTaxProvider, NumeralConnector
After saving, the Parameters tab will show the plugin’s configurable settings. Provide:
ParameterValue
API URLhttps://acumatica-integration.numeralhq.com
API KeyA sk_test_* or sk_prod_* key from your Numeral dashboard
Test ModeTrue while validating; False for production

​
3. Create a Tax Zone

Open Tax Zones (TX206000) and create a new zone.
FieldValue
Tax Zone IDNUMERAL
DescriptionNumeral-calculated tax
Default Tax CategoryThe category you want to use as a fallback
Tax Calculation ModeTax Plugin
Tax PluginNUMERAL

​
4. Assign the Tax Zone to customers and branches

For every customer whose tax should be calculated by Numeral, set their Tax Zone to NUMERAL:
  • Customers screen: AR303000
  • Branches screen: CS102000 (use this if you assign zones at the branch level)
You can update customers in bulk via Acumatica’s import scenarios or the REST API.

​
5. Test the integration

Create a sales order or invoice for a customer assigned to the NUMERAL Tax Zone with a US shipping address. Acumatica will call Numeral when you click Calculate Tax (or on save, depending on your sales document settings) and the response will populate the Tax Total. After releasing the invoice, confirm the transaction appears in your Numeral dashboard under Transactions.

​
Compatibility

ComponentRequirement
Acumatica ERP2020 R2 or later
ModulesFinancials, Sales, Customer Management
Provider IDNUMERAL
Plugin TypeNumeralConnector.TaxProvider.NumeralTaxProvider, NumeralConnector

​
Troubleshooting

Confirm you’re on Acumatica 2020 R2 or later. Older builds do not include the tax plugin extensibility points the project depends on.
The customization project must be published (not just imported). Re-open Customization Projects (SM204505) and verify the project status is Published.
Confirm the customer is on the NUMERAL Tax Zone, the shipping address is in a US tax jurisdiction, and the API Key on the Tax Plugins parameters tab is valid.
Update the API Key parameter on Tax Plugins (TX102000). No re-publish is required after parameter changes.