Design the user experience

Whether you are a technology partner working to become certified or an API customer, this section describes how you should design your TaxDocs Monitor application.

Certification for technology partners:

What should your integration’s user interface look like? What design elements should you include? For partner certification, this section describes the design elements that are necessary to become certified. These UI elements have been carefully crafted to help you create an integration that is straightforward and uncomplicated for your users and to help ensure that your integration is tax compliant.

The badge requirements are broken down into the following types:

• Mandatory: This design element is required to become certified.

• Suggested: This design element is not required, but we recommend that your UI includes suggested elements.

Mandatory/ 

Suggested

Requirements 

Notes 

Level 

Mandatory  

Setup Avalara Credentials  

The best practice is to enhance the UI for easy entry of Avalara credentials including:  

UI 

- Client ID Token 

- Secret Token 

Mandatory  

Test Authentication Connection - Ping Service 

There is one method available for service availability/PING 

UI 

Mandatory  

Comprehensive Logging 

Given that all transactions are based on request/response JSON, the connector should provide logs of the transactions for troubleshooting, if necessary. Partners can define the time necessary to keep those data within the system 

UI 

Mandatory 

Select environment option 

Provide environment option in order to allow the key user to change between sandbox and production environment 

UI 

Mandatory 

Checking Environment

Provide evidence that demonstrates which environment (Production or Sandbox) the client/partner is operating 

UI 

Suggested  

Set the timeout to API calls 

Set a timeout to API call, as recommended by best practices 

Hide configuration 

Mandatory 

API Base URL 

The URLs should be system settings 

Hide configuration 

Mandatory  

Version 

Inform version compatibility with the ERP and the connector architecture 

Documentation 

Mandatory 

Architecture 

Inform the connector architecture, as well as the prerequisites for operation, either on Premise or in the cloud 

Documentation 

Mandatory 

User interface 

Develop a user interface in order to allow the users to monitor not only the tax documents extracted from the Avalara application, as well as enabling actions (POST) from the source system 

UI 

Inbound monitor

Check the imported documents

Select the document

Use filters and export the file in the chosen format

Previous

Next