Avalara Developer Network Developer communications

Communications Integration Checklist

AvaTax for Communications API Integration Checklist to have your integration certified by Avalara we have outlined the areas of integration that are necessary to ensure a stable and robust customer experience using AvaTax for Communication with your application. To be certified for Avalara AvaTax for Communications, all of the items with an R in the Required column listed below are required elements that must be present in your integration.

Certified for Avalara AvaTax for Communications

AFC General

Required

Function

Comment

R

AvaTax for Comms Configuration

Allow customer to configure the following: username/password, company code.

Ensure password is properly secured using encryption.

R

AvaTax for Comms Test Connection button

Tests the connection to the AvaTax for Comms service and verifies credentials. This allows for troubleshooting.

R

Tax Calculation - Disable tax calculation option

The user must have an option to turn on or off the AvaTax for Comms Calculation service independent of any other Avalara product.

R

User Implementation Guide

User Implementation Guide should contain screenshots and information allowing the end user to configure for AvaTax for Comms including where credentials, company code, and where transaction/service pairs can be mapped.

R

Enable logging

Enables detailed AvaTax for Comms logging. Information captured is round-trip time and complete xml for request/response.

R

Demonstrate and document installation of software.

Customers should have an easy and trouble free installation of software.

AFC SOAP API (Only required for SOAP API user)

Required

Function

Comment

Obtain a Pcode

One of the Following is required:

R

Local data using all_adr

Explain how the all_adr data.txt is loaded and maintained. Show how this data is used for obtaining a PCode

ZipToPCode

Get Pcode by populating required information

NpaNxxToPCode

Get Pcode by populating required information

FipsToPCode,

Get Pcode by populating required information

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify pcode information.

Populate Transaction structure

See AvaTax for Comms documentation for a description of the fields and how they should be set.

One of the Following is required:

R

CalcTaxesWithPCode

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, populate BillToPcode, OriginationPcode and TerminationPCode in Transaction strcuture with PCode returned from one of utility functions FipsToPCode, ZipToPCode, or NpaNxxToPCode.

CalcTaxesWithNpaNxx

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, populate BillToNpaNxx, OriginationNpaNxx and TerminationNapNxx fields in Transaction structure with NPANXX.

CalcTaxesWithZipAddress

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, populate BillToAddress, OriginationAddress and TerminationAddress in Transaction structure.

CalcTaxesWithFipsCode

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, populate BillToFipscode, OriginationFipsCode and TerminationFIpsCode with FIPS code.

R

Parse TaxData

See AvaTax for Comms documentation for a description of fields and how they should be set.

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify both parties agree with results.

Populate Transaction structure

See AvaTax for Comms documentation for a description of the fields and how they should be set.

One of the Following is required:

R

CalcAdjWithPCode

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, use Pcode returned from either EZgeo (separate service) or from separate call to one of utility functions FipsToPCode, ZipToPCode, or NpaNxxToPCode.

CalcAdjWithNpaNxx

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, use NPANXX to identify origination and termination.

CalcAdjWithZipAddress

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, use zip code to identify origination and termination.

CalcAdjWithFipsCode

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. In this instance, use FIPS code to identify origination and termination.

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify adjustment was made and both parties agree with results.

AFC REST API (only required for REST API user)

Required

Function

Comment

Obtain a Pcode

One of the Following is required:

R

Local data using all_adr

Explain how the all_addr.txt data is loaded and maintained.

Show how this data is used for obtaining a PCode

/api/v1/Location/PCode

Get Pcode by populating required information

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify pcode information.

Populate Transaction structure

See AvaTax for Comms documentation for a description of the fields and how they should be set.

R

/api/v1/CalculateTaxes

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. This method accepts transaction data and performs appropriate tax calculations.

R

Parse TaxData

See AvaTax for Comms documentation for description of returned fields.

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify both parties agree with results.

Populate Transaction structure

See AvaTax for Comms documentation for a description of the fields and how they should be set.

R

/api/v1/CalculateAdjustments

Populate Transaction data structure with appropriate data. Parse returned TaxData data structure for results. This method accepts transaction data and performs appropriate tax adjustment calculations.

R

Have Avalara admin review results in system.

From previous call to one of the methods above, have Avalara admin review input information and output information to verify adjustment was made and both parties agree with results.