OdooWiki OCA HUB

US Sales Tax Engine - API Ninjas Provider

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

Adds the API Ninjas 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 API Ninjas through the engine's documented extension point (_provider_service_classes).

API Ninjas offers ZIP-level rate lookups with a free tier (county/city rates require a premium subscription). See https://api-ninjas.com/register to obtain an API key.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Adds API Ninjas as an optional sales tax rate provider for the US Sales Tax Engine. Users can enable it in Accounting settings, enter their API key, and use it as a fallback source of ZIP-level tax rates.

This module plugs the API Ninjas tax service into the US Sales Tax Engine. It does not change how taxes are calculated by itself; it only makes API Ninjas available as one of the rate providers the engine can call.

Where it appears: - In Accounting settings, inside the US tax providers block, a new "Enable API Ninjas" option appears. It is hidden unless the US tax engine is active and not in local mode. - When enabled, an "API Ninjas Key" field appears, shown as a password field, where you paste the X-Api-Key from your api-ninjas.com profile.

What it does: - Turning the option on or off activates or deactivates the API Ninjas provider record in the engine. - The provider is installed inactive, with priority 20, a 5-second timeout, and ZIP-level support only (no full address lookup). - When the engine asks this provider for a rate, it sends the ZIP code to API Ninjas and converts the returned state, county, city, district and total rates into the engine's standard format. - If the ZIP code is missing, the request times out, the service returns an error, or no usable rate is returned, a clear error is raised instead of a wrong rate. - The free tier only returns the state rate; county and city rates need a paid subscription, and the module warns about this when no usable data comes back. - Each successful call increases the provider's call counter.

It touches the settings screen and the us.tax.provider model used by the engine.

Depends on

l10n_us_sales_tax_engine
Models and fields (1)
  • res.config.settings · extends an existing modelus_tax_api_ninjas_key (API Ninjas Key), us_tax_enable_api_ninjas (Enable API Ninjas)

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.