Administration and utilities

This section describes the settings window of your integration.


Requirement	Use case	Endpoints/Models	Type
AvaTax configuration window	Merchants/users need to be able to access a URL that points to AvaTax and sign in using either their username/password or their account number/license key.	QueryCompanies	Required
Company code	Merchants/users must have the ability to designate which company within their account is linked to this integration.	QueryCompanies	Required
Test AvaTax connection	Merchants/users need to be able to test the connection to the AvaTax service and verify their AvaTax credentials. This is required if a company code isn't lookup isn't provided on the admin page.	Ping, QueryCompanies	Conditional
Control document recording	For this connector to be used with other integrations, merchants/users must be able to control which connector to use for recording (committing) documents to AvaTax.	CreateTransactionModel > Type
Option to disable AvaTax	Your integration must allow merchants/users to turn on or off the Avalara Calculation engine service, independent of any other Avalara product or service. For example, if a customer doesn't agree with the amount of tax that AvaTax calculated, they can turn off this calculation and post using their own calculated tax.	N/A	Required
Option to enable client-side logging	Your integration must allow merchants/users to retrieve detailed AvaTax transaction logging within the application, including the capture of round-trip processing time, and they need the complete request/response for each call made to Avalara services.	N/A	Required
User guide	Your integration must provide merchants/users with a user guide. Include in this guide screenshots and information allowing the user to configure AvaTax, including to where enter the company code, where to enter credentials, and how to map tax codes within the application.	N/A	Required
Address validation service	Your integration must allow merchants/users to validate addresses entered into AvaTax. You can use Avalara's address validation service or some other service.	ResolveAddressPost or some other third-party validator	Required