OdooWiki OCA HUB

US Sales Tax Engine - ZipTax Provider

l10n_us_sales_tax_provider_ziptax folder_open OCA/l10n-usa open_in_new
Accounting/Localizations License: LGPL-3

Adds the ZipTax (zip.tax) provider to the US Sales Tax Engine (l10n_us_sales_tax_engine). Installs and uninstalls independently of any other provider — the engine does not import this module's code, it discovers ZipTax through the engine's documented extension point (_provider_service_classes).

ZipTax offers ZIP-level rate lookups with a free tier of 100 calls/month. See https://www.zip.tax/register to obtain an API key.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Adds ZipTax (zip.tax) as an optional external sales tax rate provider for the US Sales Tax Engine. Users can enable it in Accounting settings, enter an API key, and get ZIP-code-level tax rates.

This module plugs the ZipTax (zip.tax) service into the US Sales Tax Engine. It does not work on its own: it requires the engine module, and it only becomes visible when the engine is active and not set to local mode.

Where it appears: - In Accounting settings, inside the US tax providers block, a new setting "Enable ZipTax (zip.tax)" appears. When ticked, a password-protected "ZipTax API Key" field is shown.

What it does: - Enabling the setting activates the ZipTax provider record; disabling it deactivates that provider. - The provider is created inactive by default, with priority 10, a 5-second timeout, a monthly limit of 100 calls, and ZIP-level support only (no full-address lookup). - When the engine asks ZipTax for a rate, the module sends the ZIP code to the ZipTax service and converts the answer into state, county, city, district and total rates. - It counts each successful call against the monthly limit. - A credential check is available: it tests the API key against a sample ZIP and reports success only if the service returns results.

Business rules and limits: - A ZIP code is required; without one the lookup fails. - Timeouts and HTTP errors are reported as provider errors. - If the service returns no results for a ZIP, an error is raised.

The module touches res.config.settings and us.tax.provider.

Depends on

l10n_us_sales_tax_engine
Models and fields (1)
  • res.config.settings · extends an existing modelus_tax_enable_ziptax (Enable ZipTax), us_tax_ziptax_api_key (ZipTax API Key)

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 1 confirmed, 8 with no information of 9 versions.

terminal Installation and usage

No verified information

Installation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.