Shared Services

Version sharedCompanyService
Aspects
Companies
Contacts

Company

Company model object used to create a company

This model is used in the following APIs:

Parameters
idRequired
string

Unique identifier for the given user.

companyNameRequired
string

The company name

defaultCountryRequired
string

The two character ISO-3166 country code for this company.

tenantRequired
Reference
companyCodeOptional
string

A unique code that references this company within your account

isActiveOptional
boolean

Specifies whether this company is active

hasDirectoryConsentOptional
boolean

Indicates whether the user has provided consent to include this company in the directory. This field is available starting from API version 1.1.

aspectsOptional
array
tagsOptional
array
parentOptional
Reference
childrenOptional
array

The child companies within this parent company

metaOptional
Meta
aniOptional
string

Avalara Network Identifier (ANI) - a unique 15-character identifier automatically generated at company creation.

companyIdentifiersOptional
array

Company identifiers following international standards.