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

NewAccountRequestModel

Represents a request for a new account with Avalara for a new subscriber. Contains information about the account requested and the rate plan selected.

This model is used in the following APIs:

Parameters
offerRequired
string

The offer code provided to you by your Avalara business development contact.

This code controls what services and rates the customer will be provisioned with upon creation.

If you do not know your offer code, please contact your Avalara business development representative.

connectorIdOptional
string

The id associated with the connector

campaignOptional
string

If your Avalara business development representative requests, please provide the campaign ID associated with your signup process. This campaign identifier helps Avalara match users to the context in which they learned about the product to help improve the accuracy of our messaging.

The campaign field must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail.

leadSourceOptional
string

If your Avalara business development representative requests, please provide the lead source value associated with your signup process. This lead source identifier helps Avalara match users to the context in which they learned about the product to help improve the accuracy of our messaging.

The leadSource field must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail.

effectiveDateOptional
string

The date on which the account should take effect. If null, defaults to today.

You should leave this value null unless specifically requested by your Avalara business development manager.

endDateOptional
string

The date on which the account should expire.

You should leave this value null unless specifically requested by your Avalara business development manager.

accountNameRequired
string

The name of the account to create

websiteOptional
string

Website of the new customer whose account is being created.

It is strongly recommended to provide the customer's website URL, as this will help our support representatives better assist customers.

paymentMethodIdOptional
string

Payment Method to be associated with the account.

This is strictly to be used internally unless your Avalara business development manager specifically asks you to provide this value while attempting to create an account.

firstNameRequired
string

First name of the primary contact person for this account

lastNameRequired
string

Last name of the primary contact person for this account

titleOptional
string

Title of the primary contact person for this account

phoneNumberOptional
string

Phone number of the primary contact person for this account

emailRequired
string

Email of the primary contact person for this account

usernameOptional
string

The username to be associated with the user created. If this is not provided, email address will be used as the username.

userPasswordOptional
string

If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process.

If this value is null, a temporary password is generated by the system and emailed to the user.

The user will then be asked to choose a permanent password when they first log on to the AvaTax website.

welcomeEmailOptional
string

This option controls what type of a welcome email is sent when the account is created.

  • Normal - A standard welcome email will be sent.
  • Suppressed - No email will be sent.
  • Custom - If your Avalara business development representative provides you with a customized welcome email for your customers, please select this option.
companyAddressRequired
CompanyAddress

Address information of the account being created.

companyCodeOptional
string

Company code to be assigned to the company created for this account.

If no company code is provided, this will be defaulted to "DEFAULT" company code.

propertiesOptional
array

Properties of the primary contact person for this account

acceptAvalaraTermsAndConditionsOptional
boolean

Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account.

Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.

haveReadAvalaraTermsAndConditionsOptional
boolean

Set this to true if and only if the owner of the newly created account has fully read Avalara's terms and conditions for your account.

Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key.

marketingContextOptional
object

A dynamic key-value pair for the marketing context information

accountTypeOptional
string

Type of the account to be created. Regular, Firm or FirmClient

Enum: Regular, Firm, FirmClient
isTestOptional
boolean

Set this to true if this is a test account

taxPayerIdNumberOptional
string

United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. 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.