AvaTax-REST-V2-JRE-SDK

This GitHub repository is the Java Runtime Environment 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

Maven Central

Travis-CI

Installing the JRE SDK

The AvaTax JRE SDK is available for download on Maven.

For the AvaTax JRE SDK, there are four different files available to download:

• pom : This Project Object Model is an XML file that contains information about the project and configuration details used by Maven to build the project. This file is not needed in order to run the AvaTax JRE SDK.
• jar : This is what file you will use to import into your project in order to access AvaTax. This file is needed in order to run the AvaTax JRE SDK.
• javadoc.jar : This file is documentation generated from the source code in the jar file. This file is not needed in order to run the AvaTax JRE SDK.
• sources.jar : This file contains the source code for the jar file. This file is not needed in order to run the AvaTax JRE SDK, but it is helpful to use in order to view the code within the jar file in the editor. In order to view the code, download this file and attach it as a source to the jar file.

Once you have the jar file downloaded, import it into your editor as an external jar file.

Using the JRE SDK

The JRE 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 how to connect to AvaTax in Java:

import java.math.BigDecimal;
import net.avalara.avatax.rest.client.AvaTaxClient;
import net.avalara.avatax.rest.client.TransactionBuilder;
import net.avalara.avatax.rest.client.enums.AvaTaxEnvironment;
import net.avalara.avatax.rest.client.enums.DocumentType;
import net.avalara.avatax.rest.client.enums.TransactionAddressType;
import net.avalara.avatax.rest.client.models.PingResultModel;
import net.avalara.avatax.rest.client.models.TransactionModel;

public class Program {
	public static void main(String[] args) {
		//creates our AvaTaxClient
		AvaTaxClient client = new AvaTaxClient("Test", "1.0", "localhost", AvaTaxEnvironment.Sandbox)
				.withSecurity("MyUsername", "MyPassword"); //replace with your username and password
		
		try {
			//verify that we can ping successfully
			PingResultModel ping = client.ping();
			if(ping.getAuthenticated()) {
				System.out.print("Successfully created a client!");
			}
		} catch (Exception e) {}		
		
		//builds the Transaction and creates the TransactionModel
		try {
			TransactionModel transaction = new TransactionBuilder(client, "DEFAULT", DocumentType.SalesInvoice, "ABC")
			.withAddress(TransactionAddressType.SingleLocation, "123 Main Street", null, null, "Irvine", "CA", "92615", "US")
			.withLine( new BigDecimal(100.0), new BigDecimal(1), "P0000000")
            .Create();
		} catch (Exception e) {}
		
	}

}

Updates

Two functions have been updated in 19.9.1

	downloadTaxRatesByZipCodeAsync(Date date, String region)
	downloadTaxRatesByZipCodeAsync(Date date, String region)

have been changed to

	downloadTaxRatesByZipCodeAsync(String date, String region)
	downloadTaxRatesByZipCodeAsync(String date, String region)

How to enable logging in SDK

• SLF4J The Simple Logging Facade for Java (SLF4J) serves as a simple facade or abstraction for various logging frameworks.
• Client would need to implement the slf4j provider (or binding) on their end like Log4J, Logback etc to enable logging.
• By default there is no logging enabled.
• All the attributes which are part of log message are in LogObject.java
• To enable or disable logging of request and response object, there is a boolean variable shouldLogRequestAndResponse in AvataxConstants. Default is set to FALSE
• Output of logging is in JSON format.

Following example shows how logging could be enabled on client side using Log4J.

• In build.sbt or pom.xml we would add the following changes:

// build.sbt
"org.slf4j" % "slf4j-log4j12" % "2.0.1"

//pom.xml
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>2.0.1</version>
</dependency>

• Make sure to refresh the project to get the latest dependencies
• Under src - > main - > resources folder create log4j.properties file and add the configurations which would cater your needs. One such example is below

log4j.rootLogger=INFO, STDOUT
log4j.appender.STDOUT=org.apache.log4j.ConsoleAppender
log4j.appender.STDOUT.layout=org.apache.log4j.PatternLayout
log4j.appender.STDOUT.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

Please note that log4j.properties(or any other configuration) file could contain a variety of configurations such as adding logs to a log file, how to construct the log file name etc. Current example only shows the configuration to display logs at console only.