udevrandom / avataxclient
Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API. Updated to use Guzzle 7 for Laravel compatibility.
Requires
- php: >=5.5.9
- guzzlehttp/guzzle: ~7
Requires (Dev)
- phpunit/phpunit: 5.7
- dev-master
- 20.13
- 20.12.1
- 20.12.0.x-dev
- 20.9.0.x-dev
- 20.9.0
- 20.8.0.x-dev
- 20.8.0
- 20.7.0
- 20.6.0.x-dev
- 20.6.0
- 20.5.0.x-dev
- 20.5.0
- 20.1.1
- 20.1.0
- 19.12.1
- 19.11.x-dev
- 19.11.0
- 19.10.x-dev
- 19.10.0
- 19.9.0.x-dev
- 19.9.0
- 19.8.0.x-dev
- 19.8.0
- 19.7.0.x-dev
- 19.7.0.1
- 19.7.0.1-dev
- 19.7.0
- 19.6.0.x-dev
- 19.6.0
- 19.5.0.x-dev
- 19.5.0
- 19.4.0.x-dev
- 19.4.0
- 19.3.0.x-dev
- 19.3.0
- v19.2.0.x-dev
- 19.2.0
- v19.1.1.x-dev
- 19.1.1
- 18.12.0
- 18.10.5.260
- 18.9.0.234
- 18.5.1.208
- 18.4.4.191
- 18.4.3.191
- 18.3.1.176
- 18.2.x-dev
- 18.2.0.167
- 18.1.x-dev
- 18.1.2.x-dev
- 18.1.2.161
- 17.12.0.149
- 17.12.0.147
- 17.8.1.x-dev
- 17.8.1.120
- 17.7.0.96
- 17.5.0.67
- 2.17.4.58
- 2.17.3.48
- 2.17.2.43
- 2.17.1.3
- 2.17.1
- 2.2.10.x-dev
- 2.2.9.x-dev
- 2.2.8.x-dev
- 2.2.7.x-dev
- 2.2.6.x-dev
- 2.2.5.x-dev
- 2.2.4.x-dev
- 2.2.3.x-dev
- 2.2.2.x-dev
- 1.1.5.x-dev
- 1.1.4.x-dev
- 1.1.3.x-dev
- 1.1.2.x-dev
- 1.1.1.x-dev
- 0.0.2.x-dev
- 0.0.1.x-dev
- 0.0.0.x-dev
- dev-20-7-update
- dev-timeoutUpdate
- dev-20.1-Release
- dev-Fixed19.12
- dev-test
- dev-19-oct
This package is auto-updated.
Last update: 2024-10-18 06:36:43 UTC
README
This GitHub repository is the PHP SDK for Avalara's world-class tax service, AvaTax. It uses the AvaTax REST v2 API, which is a fully REST implementation and provides a single client for all AvaTax functionality. For more information about AvaTax REST v2, please visit Avalara's Developer Network or view the online Swagger documentation.
Build Status
Packagist
Travis-CI
Installing the PHP SDK
The AvaTax PHP SDK is available as a Composer package.
To use the AvaTax PHP SDK from Composer:
- Add a
composer.json
file to your project and link to AvaTax:
{ "require": { "avalara/avataxclient": "*" } }
- Run
composer install
to download the latest version.
Using the PHP SDK
The PHP SDK uses a fluent interface to define a connection to AvaTax and to make API calls to calculate tax on transactions. Here's an example of connecting to the API.
<?php // Include the AvaTaxClient library require __DIR__ . '/vendor/autoload.php'; use Avalara\AvaTaxClient; // Create a new client $client = new Avalara\AvaTaxClient('phpTestApp', '1.0', 'localhost', 'sandbox'); $client->withSecurity('myUsername', 'myPassword'); // If I am debugging, I can call 'Ping' to see if I am connected to the server $p = $client->ping(); echo('<h2>Ping</h2>'); echo('<pre>' . json_encode($p, JSON_PRETTY_PRINT) . '</pre>'); if ($p->authenticated == true) { echo '<p>Authenticated!</p>'; } // Create a simple transaction for $100 using the fluent transaction builder $tb = new Avalara\TransactionBuilder($client, "DEFAULT", Avalara\DocumentType::C_SALESINVOICE, 'ABC'); $t = $tb->withAddress('SingleLocation', '123 Main Street', null, null, 'Irvine', 'CA', '92615', 'US') ->withLine(100.0, 1, null, "P0000000") ->create(); echo('<h2>Transaction #1</h2>'); echo('<pre>' . json_encode($t, JSON_PRETTY_PRINT) . '</pre>'); // Now, let's create a more complex transaction! $tb = new Avalara\TransactionBuilder($client, "DEFAULT", Avalara\DocumentType::C_SALESINVOICE, 'ABC'); $t = $tb->withAddress('ShipFrom', '123 Main Street', null, null, 'Irvine', 'CA', '92615', 'US') ->withAddress('ShipTo', '100 Ravine Lane', null, null, 'Bainbridge Island', 'WA', '98110', 'US') ->withLine(100.0, 1, null, "P0000000") ->withLine(1234.56, 1, null, "P0000000") ->withExemptLine(50.0, null, "NT") ->withLine(2000.0, 1, null, "P0000000") ->withLineAddress(Avalara\TransactionAddressType::C_SHIPFROM, "123 Main Street", null, null, "Irvine", "CA", "92615", "US") ->withLineAddress(Avalara\TransactionAddressType::C_SHIPTO, "1500 Broadway", null, null, "New York", "NY", "10019", "US") ->withLine(50.0, 1, null, "FR010000") ->create(); echo('<h2>Transaction #2</h2>'); echo('<pre>' . json_encode($t, JSON_PRETTY_PRINT) . '</pre>'); ?>