See what the Avalara ECM integration can do →
This article lists the Avalara AvaTax API endpoints the integration calls, grouped by entity. Use it for firewall allow-listing, troubleshooting, and checking whether a published Avalara AvaTax API change affects the integration.
API Endpoints Intro
The integration calls the Avalara AvaTax REST API (version 2). The base URL depends on the environment configured in the API Url subscription setting:
Environment | Base URL |
Production | |
Sandbox |
In the endpoint patterns below, [Base URL] stands for the address above for your environment, {CompanyId} is your Avalara AvaTax company identifier (the API Client Id), and {customerCode}, {companyId}, and {certificateId} are the relevant record identifiers.
Table of Contents
Company Endpoints
Certificate Endpoints
Customer Endpoints
Definitions Endpoints
Utilities Endpoints
Company Endpoints
Create a Company (POST)
[Base URL]/v2/companies
Get a Company by Id (GET)
[Base URL]/v2/companies/{companyId}
Update a Company (PUT)
[Base URL]/v2/companies/{companyId}
Find a Company by Code (GET)
[Base URL]/v2/companies?$filter=companyCode eq '{companyCode}'
Certificate Endpoints
Set Up Certificates (POST)
[Base URL]/v2/companies/{companyId}/certificates/setup
Check Certificate Setup Status (GET)
[Base URL]/v2/companies/{companyId}/certificates/setup
Get Company Certificates (GET)
[Base URL]/v2/companies/{companyId}/certificates
Create a Certificate (POST)
[Base URL]/v2/companies/{companyId}/certificates
Update a Certificate (PUT)
[Base URL]/v2/companies/{companyId}/certificates/{certificateId}
Customer Endpoints
Create a Customer (POST)
[Base URL]/v2/companies/{CompanyId}/customers
Get a Customer by Code (GET)
[Base URL]/v2/companies/{CompanyId}/customers/{customerCode}
Find Customers (GET)
[Base URL]/v2/companies/{CompanyId}/customers?$filter=customerCode eq '{customerCode}'&$include=CustomFields
Update a Customer (PUT)
[Base URL]/v2/companies/{CompanyId}/customers/{customerCode}
Get a Customer's Certificates (GET)
[Base URL]/v2/companies/{CompanyId}/customers/{customerCode}/certificates
Get All Certificates with Customers (GET)
[Base URL]/v2/companies/{CompanyId}/certificates?$include=customers
Send a CertExpress Invitation (POST)
[Base URL]/v2/companies/{CompanyId}/customers/{customerCode}/certexpressinvites
Definitions Endpoints
Get Certificate Exposure Zones (GET)
[Base URL]/v2/definitions/certificateexposurezones
Get Certificate Exemption Reasons (GET)
[Base URL]/v2/definitions/certificateexemptreasons
Utilities Endpoints
Ping (GET)
[Base URL]/api/v2/utilities/ping
Authentication
The Avalara AvaTax API uses basic authentication: each request carries the API User and API Password configured on the subscription. See Avalara's authentication documentation for details.
Related Documents