AvaTax for VAT

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

CompanyModel

A company or business entity.

This model is used in the following APIs:

Parameters
idRequired
integer

The unique ID number of this company.

accountIdRequired
integer

The unique ID number of the account this company belongs to.

parentCompanyIdOptional
integer

If this company is fully owned by another company, this is the unique identity of the parent company.

sstPidOptional
string

If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board.

companyCodeOptional
string

A unique code that references this company within your account.

nameRequired
string

The name of this company, as shown to customers.

isDefaultOptional
boolean

This flag is true if this company is the default company for this account. Only one company may be set as the default.

defaultLocationIdOptional
integer

If set, this is the unique ID number of the default location for this company.

isActiveOptional
boolean

This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions.

taxpayerIdNumberOptional
string

For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.

isFeinOptional
boolean

Set this field to true if the taxPayerIdNumber is a FEIN.

hasProfileOptional
boolean

Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent.

isReportingEntityOptional
boolean

Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company.

sstEffectiveDateOptional
string

If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.

defaultCountryRequired
string

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

baseCurrencyCodeOptional
string

This is the three character ISO-4217 currency code of the default currency used by this company.

roundingLevelIdOptional
string

Indicates whether this company prefers to round amounts at the document level or line level.

Enum: Line, Document
warningsEnabledOptional
boolean

Set this value to true to receive warnings in API calls via SOAP.

isTestOptional
boolean

Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes.

taxDependencyLevelIdOptional
string

Used to apply tax detail dependency at a jurisdiction level.

Enum: Document, State, TaxRegion, Address
inProgressOptional
boolean

Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions.

businessIdentificationNoOptional
string

Business Identification No

createdDateOptional
string

The date when this record was created.

createdUserIdOptional
integer

The User ID of the user who created this record.

modifiedDateOptional
string

The date/time when this record was last modified.

modifiedUserIdOptional
integer

The user ID of the user who last modified this record.

contactsOptional
array

Optional: A list of contacts defined for this company. To fetch this list, add the query string ?$include=Contacts to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

itemsOptional
array

Optional: A list of items defined for this company. To fetch this list, add the query string ?$include=Items to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

locationsOptional
array

Optional: A list of locations defined for this company. To fetch this list, add the query string ?$include=Locations to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

nexusOptional
array

Optional: A list of nexus defined for this company. To fetch this list, add the query string ?$include=Nexus to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

settingsOptional
array

Optional: A list of settings defined for this company. To fetch this list, add the query string ?$include=Settings to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

taxCodesOptional
array

Optional: A list of tax codes defined for this company. To fetch this list, add the query string ?$include=TaxCodes to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

taxRulesOptional
array

Optional: A list of tax rules defined for this company. To fetch this list, add the query string ?$include=TaxRules to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

upcsOptional
array

Optional: A list of UPCs defined for this company. To fetch this list, add the query string ?$include=UPCs to your URL.

When calling CreateCompany, you may provide a list of objects in this element and they will be created alongside the company. The UpdateCompany API does not permit updating nested objects.

nonReportingChildCompaniesOptional
array

Optional: A list of non reporting child companies associated with this company. To fetch this list, add the query string ?$include=NonReportingChildren to your URL.

exemptCertsOptional
array

DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the ListCertificates API.

mossIdOptional
string

The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.

mossCountryOptional
string

The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.

parametersOptional
array

The parameters of a company

supplierandcustomersOptional
array

The customers and suppliers of a company

isDeletedOptional
boolean

A boolean flag to identify if the company is deleted

isAdvSaveOptional
boolean

A boolean flag to identify if the company saves advanced rules after calculation.

companyUrlOptional
string

The url of the company.

companyDescriptionOptional
string

The description of the company.