Skip to navigation

Returns a list of all non-obsolete licensed master company IDs that the requesting user has access to as of the requested date.

View as Markdown

Access control: this endpoint is available to users with the everyone role.

Returns a list of master company details that the requesting user has access to. Only non-obsolete, licensed master companies are included. The effective date must not be in the future.

Each result includes the master company ID, name, deployment status, active status, and licensing information for Returns Excise and AvaTax Excise products.

Authentication

Authorizationstring
API Key authentication via header

Headers

X-Avalara-ClientstringOptionalDefaults to Swagger UI; 5.64.21.2340; Custom; 1.0

Identifies the software you are using to call this API. For more information on the client header, see Client Headers.

Query parameters

effectiveDatedatetimeRequired
The effective date used to determine accessible master companies.

Response

Returns a list of master company details available to the requesting user.
MasterCompanyIdintegerOptional
Master company ID
NamestringOptional
Master company name
IsDeployedbooleanOptional
If the master company is deployed
IsActivebooleanOptional
If the master company is active
HasReturnsExcisebooleanOptional
Is returns excise enabled
HasAvaTaxExcisebooleanOptional
Is AvaTax excise enabled