https://github.com/avadev/avatax-rest-v2-js-sdk
Sales Tax API SDK for Javascript / Node and AvaTax REST
https://github.com/avadev/avatax-rest-v2-js-sdk
javascript nodejs sales-tax sales-tax-api sdk tax-rate tax-rates
Last synced: about 1 year ago
JSON representation
Sales Tax API SDK for Javascript / Node and AvaTax REST
- Host: GitHub
- URL: https://github.com/avadev/avatax-rest-v2-js-sdk
- Owner: avadev
- License: apache-2.0
- Created: 2016-12-28T18:56:10.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T02:15:35.000Z (about 1 year ago)
- Last Synced: 2025-04-11T03:25:12.067Z (about 1 year ago)
- Topics: javascript, nodejs, sales-tax, sales-tax-api, sdk, tax-rate, tax-rates
- Language: TypeScript
- Homepage: https://developer.avalara.com/sdk/
- Size: 4.16 MB
- Stars: 28
- Watchers: 12
- Forks: 37
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AvaTax Rest V2 Node.js SDK
AvaTax v2 SDK for languages using node.js
[](https://www.npmjs.org/package/avatax)
[](https://travis-ci.org/avadev/AvaTax-REST-V2-JS-SDK)
[](https://www.npmjs.com/package/avatax)
[](https://runkit.com/npm/avatax)
## Installation
Install the package with:
``` bash
# using npm
npm install avatax
# using yarn
yarn add avatax
```
## Usage
### Configuration
``` js
// es5 import
var Avatax = require('avatax');
// es6/7 import
// import Avatax from 'avatax';
// resolve configuration, credentials and logOptions
const config = {
appName: 'your-app',
appVersion: '1.0',
environment: 'sandbox',
machineName: 'your-machine-name',
timeout: 5000, // optional, default 20 min
logOptions: {
logEnabled: true, // toggle logging on or off, by default its off.
logLevel: 3, // logLevel that will be used, Options are LogLevel.Error (0), LogLevel.Warn (1), LogLevel.Info (2), LogLevel.Debug (3)
logRequestAndResponseInfo: true, // Toggle logging of the request and response bodies on and off.
logger: myCustomLogger // (OPTIONAL) Custom logger can be passed in that implements the BaseLogger interface (e.g. debug, info, warn, error, and log functions) Otherwise console.log/error etc will be used by default.
},
customHttpAgent: new https.Agent({keepAlive: true}), // (OPTIONAL) Define a custom https agent, import https from node to use this constructor. See https://node.readthedocs.io/en/latest/api/https/#https_class_https_agent for more information.
enableStrictTypeConversion: true // Ensures that all responses returned by the API methods will be type-safe and match the Models explicitly, For Example, the enums will be returned as integer values instead of as Strings as previously were.
};
const creds = {
username: '',
password: ''
};
var client = new Avatax(config).withSecurity(creds);
```
### Tax Calculation
``` js
const taxDocument = {
type: 'SalesInvoice',
companyCode: 'abc123',
date: '2017-04-12',
customerCode: 'ABC',
purchaseOrderNo: '2017-04-12-001',
addresses: {
SingleLocation: {
line1: '123 Main Street',
city: 'Irvine',
region: 'CA',
country: 'US',
postalCode: '92615'
}
},
lines: [
{
number: '1',
quantity: 1,
amount: 100,
taxCode: 'PS081282',
itemCode: 'Y0001',
description: 'Yarn'
}
],
commit: true,
currencyCode: 'USD',
description: 'Yarn'
}
return client.createTransaction({ model: taxDocument })
.then(result => {
// response tax document
console.log(result);
});
```
### Address Validation
``` js
const address = {
city: 'irvine',
postalCode: '92615',
region: 'ca',
country: 'us'
};
return client.resolveAddress(address)
.then(result => {
// address validation result
console.log(result);
});
```
## Release Notes
Please see the [Github releases](https://github.com/avadev/AvaTax-REST-V2-JS-SDK/releases) for in-depth release notes.
## Typescript support
As of version 22.11.0, Typescript support is included in the SDK. Models and Enums included in addition to typing for all of the API methods and parameters. The team welcomes any feedback on this feature.
Models and Enums can be imported into Typescript projects as follows:
```typescript
import { AddressResolutionModel } from 'avatax/lib/models';
import { AddressCategoryId } from 'avatax/lib/enums';
```
## SDK Development
### Adding integration test credentials
Running integration tests will hit the deployed lower environment
Test credentials are resolved in the following order:
1. Environment variables
The following environment variables will get loaded as test credentials
```bash
SANDBOX_USERNAME="your-username"
SANDBOX_PASSWORD="your-password"
```
2. Local credentials file
You can also add a local credentials file to the the path "/local_creds.json". This file will be gitignored
```json
{
"username": "your-username",
"password": "your-password"
}
```
3. Static (mock) values
The mocked values are used for unit tests via 'nock'.
The test credentials helper can be found here
https://github.com/avadev/AvaTax-REST-V2-JS-SDK/blob/master/test/helpers/load_creds.js
### Publish tags upstream
``` bash
# assuming a tag of v17.5.2 and a remote of 'upstream'
git push upstream v17.5.2
```