Download the PHP package ejosterberg/opensalestax-whmcs without Composer

On this page you can find all versions of the php package ejosterberg/opensalestax-whmcs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package opensalestax-whmcs

OpenSalesTax for WHMCS

CI

A WHMCS addon module that replaces WHMCS's built-in tax handling with the self-hosted OpenSalesTax engine for destination-based US sales tax on hosting, domain, and SaaS invoices.

Status: v0.1.0-alpha — first installable release, hosting-provider integration testing pending. See specs/handoff.md for the v0.2 roadmap.

What it does

What it does NOT do

Install

Via the merchant ZIP (recommended)

  1. Download opensalestax-whmcs-vX.Y.Z.zip from the Releases page.
  2. In WHMCS Admin: System Settings -> Addon Modules -> Upload Module, select the ZIP, click upload.
  3. The addon now appears in the Addon Modules list. Click Activate.
  4. Open Addons -> OpenSalesTax in the top nav.
  5. Configure:
    • Engine URL — base URL of your self-hosted OST engine, e.g. https://ostax.example.com.
    • (optional) API key — bearer token if your engine is auth-gated.
    • TLS verification — leave Yes for production.
    • Allow private-network engine URLYes only for self-hosted-on-LAN.
    • Fail hard on engine errors — leave No (default) so engine outages don't block invoice creation.
    • Per-state nexus filter + Nexus states — leave the filter No to engage every US destination.
    • Cache TTL (seconds) — default 3600. Lower for testing.
  6. Save.
  7. Create a test invoice for a US client — verify the tax line uses your destination-based engine output.

Via composer (developer install)

This pulls the source, but you still need to copy modules/addons/opensalestax/ into your WHMCS install. The ZIP build is the canonical merchant artifact.

Compatibility

WHMCS 8.x (8.0+)
PHP 8.2 / 8.3 / 8.4
OpenSalesTax engine v0.14+ (any release that ships the v1 calculate API)
OpenSalesTax PHP SDK ejosterberg/opensalestax ^0.1 (bundled in the ZIP)

WHMCS 7.x is not officially supported; the addon-module API hooks have been stable since 7.0 but it's untested.

Configuration reference

Settings are stored in WHMCS's tbladdonmodules table under module = 'opensalestax'.

Key Type Default Notes
engine_url text (empty) Empty = addon is inert
api_key password (empty) Optional bearer token
tls_verify yes/no yes Constitution §6
allow_private_nets yes/no no Constitution §6
fail_hard yes/no no Constitution §5
nexus_enabled yes/no no Constitution §9
nexus_states text (empty) Comma-separated 2-letter codes
cache_ttl_seconds text 3600 Bounded 0-86400

Architecture decisions

Development

Built and tested with PHP 8.2 (XAMPP on Windows). See CONTRIBUTING.md for the commit / DCO / dual-license rules.

To produce the merchant ZIP locally:

(Linux / macOS users can drop the PHP_BIN / COMPOSER_BIN overrides if php and composer are on $PATH.)

License

Distributed under your choice of:

SPDX expression: Apache-2.0 OR GPL-2.0-or-later.

See CONTRIBUTING.md).

Disclaimer

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.

Sibling connectors


All versions of opensalestax-whmcs with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-json Version *
ejosterberg/opensalestax Version ^0.3.0
guzzlehttp/guzzle Version ^7.8
psr/log Version ^1.0 || ^2.0 || ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ejosterberg/opensalestax-whmcs contains the following files

Loading the files please wait ...