Skip to navigation

Planning your integration

View as Markdown

This section provides an overview of requirements that exist for both AvaTax and Document Management in order to become a certified partner.

Administration and utilities

This section describes the requirements for the Settings window of your integration.

Requirement

Use Case

Endpoints

Required/Conditional/Suggested

Configuration window

Merchants/users need to be able to access a URL that points to AvaTax and Document Management. From this URL, users must be able to log in using either their username/password or their account number/license key. They also need to be able to perform a company code lookup.

N/A

Required

Test connection button

Merchants/users need to be able to test the connection to the AvaTax and Document Management services and verify their credentials.

Ping, QueryCompanies

Required

Client-side logging

Merchants/users must have the option to retrieve detailed logging within the application.

N/A

Required

User guide

Merchants/users must have a way to access a User Guide. This guide should contain screenshots and information allowing the end user to configure AvaTax and Document Management as well as information on the functionality of the integration.

N/A

Required

Request timeout definition

Merchants/users should define a timeout length on their backend service for AvaTax and Document Management requests.

N/A

Suggested

Previous

Next

Part of the AvaTax and ECM integration guide. Open the full “Planning your integration” milestone on Avalara to see every page in this section.