Skip to main content

OpenSalesTax connector for Odoo 17 — destination-based US sales tax via the OpenSalesTax engine

Project description

opensalestax-odoo

PyPI License: LGPL v3 Odoo 16.0 Odoo 17.0 Odoo 18.0 Odoo 19.0

Destination-based US sales tax for Odoo Community. Replaces static tax-rate configuration with live calculation against an OpenSalesTax engine — your own self-hosted instance, no per-transaction fees, no SaaS lock-in.

The free, self-hostable answer to Avalara on Odoo Community Edition. Available on all four current Odoo major versions — 16.0, 17.0, 18.0, and 19.0 — same module, branch-per-version per the OCA convention.

Branch matrix

Pick the branch matching your Odoo install. Releases are independent per branch.

Odoo version Branch PyPI artifact Status
16.0 16.0 odoo-addon-account-ostax==16.0.* shipping
17.0 17.0 odoo-addon-account-ostax==17.0.* shipping
18.0 18.0 odoo-addon-account-ostax==18.0.* shipping (default)
19.0 19.0 odoo-addon-account-ostax==19.0.* shipping (Odoo 19 GA confirmed)

What you get

  • Sales orders, customer invoices, credit notes/refunds, vendor bills, POS, purchase orders — all with destination-based per-jurisdiction US tax
  • Per-jurisdiction breakdown stored on every move (state / county / city / district), rendered on the form view for full audit trail
  • Customer exemption certificates on res.partner
  • Multi-company support — settings scoped per company
  • Fiscal-position interop — non-US partners route through Odoo's standard "Export" mapping; the connector only engages for US shipping addresses
  • Settings page with engine connection test, cache TTL, fail-soft toggle
  • Optional admin debug log of recent calculations

Install

# Match the branch to your Odoo major:
pip install opensalestax  # the Python SDK
pip install odoo-addon-account-ostax==18.0.0.1.0  # this connector for Odoo 18

# Or install from source:
git clone -b 18.0 https://github.com/ejosterberg/opensalestax-odoo.git
cd opensalestax-odoo
# Symlink or copy account_ostax/ into your Odoo addons-path

Then in Odoo: Apps → search "OpenSalesTax" → Install, then Settings → Accounting → OpenSalesTax to configure the engine URL.

How it works

The connector overrides account.tax.compute_all. When a US partner with a valid 5-digit ZIP is on a sale order / invoice / POS order / vendor bill, compute_all calls the OpenSalesTax engine via the Python SDK and replaces the static catalog rate with the engine's per-jurisdiction breakdown. Non-US partners fall through to Odoo's standard fiscal-position handling.

Calculation only

Tax calculations are provided as-is for convenience. The merchant is solely responsible for tax-collection accuracy and remittance to the appropriate jurisdictions. Verify against your state Department of Revenue before remitting.

This module does NOT file returns, remit collected tax, validate addresses, or provide legal/tax advice.

License

LGPL-3 (or-later) per the project's per-platform license carve-out. Apache-2.0 SDK consumed. DCO sign-off required on every commit; no AI co-author trailers. See CONTRIBUTING.md.

Status

Production-grade across all four Odoo majors. v0.1.5+ is shipping on PyPI as odoo-addon-account-ostax==<branch>.0.1.5 for 16.0, 17.0, 18.0, and 19.0.

What works on every branch:

  • Real destination-based per-jurisdiction US sales tax on every customer invoice, sale order, credit note (state / county / city / district splits in the totals area)
  • Engine audit JSON captured on _post() (engine version, calc timestamp, full per-jurisdiction detail)
  • Customer exemption certificate handling
  • Multi-company isolation
  • Settings page + Test Connection action
  • Optional admin debug log
  • Optional 90-day archive cron for jurisdictions you've stopped shipping to

How it's wired:

  • Odoo 18 + 19 override account.tax._add_tax_details_in_base_lines using the official manual_tax_amounts injection mechanism — same hook the proprietary Avalara module uses, no internal-API fragility.
  • Odoo 16 + 17 override the legacy compute_all method (the new batch engine arrived in 18.0).
  • Per-version settings xpath: 16 uses //div[@data-key='account']; 17/18/19 use //app[@name='account'].

Verified end-to-end on real Odoo + Postgres in Docker against the live engine, including Odoo's official US chart of accounts (l10n_us): $100 invoice to MSP (ZIP 55401) produces amount_tax=9.03 with 6 per-jurisdiction lines. 32 unit tests pass on each branch.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odoo_addon_account_ostax-17.0.0.1.11.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_account_ostax-17.0.0.1.11.tar.gz.

File metadata

File hashes

Hashes for odoo_addon_account_ostax-17.0.0.1.11.tar.gz
Algorithm Hash digest
SHA256 abee95dfe209d151b53fbd3642692ba8955ddf3695564c59131b23683c433c6b
MD5 cb7288d6e0706d6f3fe2d5f21db89ee4
BLAKE2b-256 9d2acf730877dcbc5c94e609d9d9200241c677c61459b8bfd7513be6011ad6ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_addon_account_ostax-17.0.0.1.11.tar.gz:

Publisher: publish.yml on ejosterberg/opensalestax-odoo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file odoo_addon_account_ostax-17.0.0.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_account_ostax-17.0.0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 d45ffb9c25f119e0c914cf04ba4a679e8eaa5ab30ca6258d78eeab7fef0088a9
MD5 4fd718efc94e3acb7f2b95d0383f3196
BLAKE2b-256 7d6ce5f375649e66b1802d51a0186cb0bffe5244774b79e6a5eb10636aa334e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_addon_account_ostax-17.0.0.1.11-py3-none-any.whl:

Publisher: publish.yml on ejosterberg/opensalestax-odoo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page