Package net.avalara.avatax.rest.client.models

Class NewAccountRequestModel

java.lang.Object

net.avalara.avatax.rest.client.models.NewAccountRequestModel

public class NewAccountRequestModel
extends Object

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

Constructor Summary

Constructors

Constructor	Description
NewAccountRequestModel()

Method Summary

Modifier and Type	Method	Description
Boolean	getAcceptAvalaraTermsAndConditions()	Getter for acceptAvalaraTermsAndConditions Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account.
String	getAccountName()	Getter for accountName The name of the account to create
AccountTypeId	getAccountType()	Getter for accountType Type of the account to be created.
String	getCampaign()	Getter for campaign If your Avalara business development representative requests, please provide the campaign ID associated with your signup process.
CompanyAddress	getCompanyAddress()	Getter for companyAddress
String	getCompanyCode()	Getter for companyCode Company code to be assigned to the company created for this account.
String	getConnectorId()	Getter for connectorId The id associated with the connector
Date	getEffectiveDate()	Getter for effectiveDate The date on which the account should take effect.
String	getEmail()	Getter for email Email of the primary contact person for this account
Date	getEndDate()	Getter for endDate The date on which the account should expire.
String	getFirstName()	Getter for firstName First name of the primary contact person for this account
Boolean	getHaveReadAvalaraTermsAndConditions()	Getter for haveReadAvalaraTermsAndConditions 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.
String	getLastName()	Getter for lastName Last name of the primary contact person for this account
String	getLeadSource()	Getter for leadSource If your Avalara business development representative requests, please provide the lead source value associated with your signup process.
HashMap<String,String>	getMarketingContext()	Getter for marketingContext A dynamic key-value pair for the marketing context information
String	getOffer()	Getter for offer The offer code provided to you by your Avalara business development contact.
String	getPaymentMethodId()	Getter for paymentMethodId Payment Method to be associated with the account.
String	getPhoneNumber()	Getter for phoneNumber Phone number of the primary contact person for this account
ArrayList<String>	getProperties()	Getter for properties Properties of the primary contact person for this account
String	getTaxPayerIdNumber()	Getter for taxPayerIdNumber 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.
String	getTitle()	Getter for title Title of the primary contact person for this account
String	getUsername()	Getter for username The username to be associated with the user created.
String	getUserPassword()	Getter for userPassword If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process.
String	getWebsite()	Getter for website Website of the new customer whose account is being created.
String	getWelcomeEmail()	Getter for welcomeEmail This option controls what type of a welcome email is sent when the account is created.
void	setAcceptAvalaraTermsAndConditions(Boolean value)	Setter for acceptAvalaraTermsAndConditions Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account.
void	setAccountName(String value)	Setter for accountName The name of the account to create
void	setAccountType(AccountTypeId value)	Setter for accountType Type of the account to be created.
void	setCampaign(String value)	Setter for campaign If your Avalara business development representative requests, please provide the campaign ID associated with your signup process.
void	setCompanyAddress(CompanyAddress value)	Setter for companyAddress
void	setCompanyCode(String value)	Setter for companyCode Company code to be assigned to the company created for this account.
void	setConnectorId(String value)	Setter for connectorId The id associated with the connector
void	setEffectiveDate(Date value)	Setter for effectiveDate The date on which the account should take effect.
void	setEmail(String value)	Setter for email Email of the primary contact person for this account
void	setEndDate(Date value)	Setter for endDate The date on which the account should expire.
void	setFirstName(String value)	Setter for firstName First name of the primary contact person for this account
void	setHaveReadAvalaraTermsAndConditions(Boolean value)	Setter for haveReadAvalaraTermsAndConditions 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.
void	setLastName(String value)	Setter for lastName Last name of the primary contact person for this account
void	setLeadSource(String value)	Setter for leadSource If your Avalara business development representative requests, please provide the lead source value associated with your signup process.
void	setMarketingContext(HashMap<String,String> value)	Setter for marketingContext A dynamic key-value pair for the marketing context information
void	setOffer(String value)	Setter for offer The offer code provided to you by your Avalara business development contact.
void	setPaymentMethodId(String value)	Setter for paymentMethodId Payment Method to be associated with the account.
void	setPhoneNumber(String value)	Setter for phoneNumber Phone number of the primary contact person for this account
void	setProperties(ArrayList<String> value)	Setter for properties Properties of the primary contact person for this account
void	setTaxPayerIdNumber(String value)	Setter for taxPayerIdNumber 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.
void	setTitle(String value)	Setter for title Title of the primary contact person for this account
void	setUsername(String value)	Setter for username The username to be associated with the user created.
void	setUserPassword(String value)	Setter for userPassword If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process.
void	setWebsite(String value)	Setter for website Website of the new customer whose account is being created.
void	setWelcomeEmail(String value)	Setter for welcomeEmail This option controls what type of a welcome email is sent when the account is created.
String	toString()	Returns a JSON string representation of NewAccountRequestModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

NewAccountRequestModel

public NewAccountRequestModel()

Method Details

getOffer

public String getOffer()

Getter for offer 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.

setOffer

public void setOffer(String value)

Setter for offer 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.

getConnectorId

public String getConnectorId()

Getter for connectorId The id associated with the connector

setConnectorId

public void setConnectorId(String value)

Setter for connectorId The id associated with the connector

getCampaign

public String getCampaign()

Getter for campaign 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.

setCampaign

public void setCampaign(String value)

Setter for campaign 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.

getLeadSource

public String getLeadSource()

Getter for leadSource 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.

setLeadSource

public void setLeadSource(String value)

Setter for leadSource 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.

getEffectiveDate

public Date getEffectiveDate()

Getter for effectiveDate 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.

setEffectiveDate

public void setEffectiveDate(Date value)

Setter for effectiveDate 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.

getEndDate

public Date getEndDate()

Getter for endDate The date on which the account should expire. You should leave this value `null` unless specifically requested by your Avalara business development manager.

setEndDate

public void setEndDate(Date value)

Setter for endDate The date on which the account should expire. You should leave this value `null` unless specifically requested by your Avalara business development manager.

getAccountName

public String getAccountName()

Getter for accountName The name of the account to create

setAccountName

public void setAccountName(String value)

Setter for accountName The name of the account to create

getWebsite

public String getWebsite()

Getter for website 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.

setWebsite

public void setWebsite(String value)

Setter for website 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.

getPaymentMethodId

public String getPaymentMethodId()

Getter for paymentMethodId 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.

setPaymentMethodId

public void setPaymentMethodId(String value)

Setter for paymentMethodId 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.

getFirstName

public String getFirstName()

Getter for firstName First name of the primary contact person for this account

setFirstName

public void setFirstName(String value)

Setter for firstName First name of the primary contact person for this account

getLastName

public String getLastName()

Getter for lastName Last name of the primary contact person for this account

setLastName

public void setLastName(String value)

Setter for lastName Last name of the primary contact person for this account

getTitle

public String getTitle()

Getter for title Title of the primary contact person for this account

setTitle

public void setTitle(String value)

Setter for title Title of the primary contact person for this account

getPhoneNumber

public String getPhoneNumber()

Getter for phoneNumber Phone number of the primary contact person for this account

setPhoneNumber

public void setPhoneNumber(String value)

Setter for phoneNumber Phone number of the primary contact person for this account

getEmail

public String getEmail()

Getter for email Email of the primary contact person for this account

setEmail

public void setEmail(String value)

Setter for email Email of the primary contact person for this account

getUsername

public String getUsername()

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

setUsername

public void setUsername(String value)

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

getUserPassword

public String getUserPassword()

Getter for userPassword 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.

setUserPassword

public void setUserPassword(String value)

Setter for userPassword 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.

getWelcomeEmail

public String getWelcomeEmail()

Getter for welcomeEmail 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.

setWelcomeEmail

public void setWelcomeEmail(String value)

Setter for welcomeEmail 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.

getCompanyAddress

public CompanyAddress getCompanyAddress()

Getter for companyAddress

setCompanyAddress

public void setCompanyAddress(CompanyAddress value)

Setter for companyAddress

getCompanyCode

public String getCompanyCode()

Getter for companyCode 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.

setCompanyCode

public void setCompanyCode(String value)

Setter for companyCode 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.

getProperties

public ArrayList<String> getProperties()

Getter for properties Properties of the primary contact person for this account

setProperties

public void setProperties(ArrayList<String> value)

Setter for properties Properties of the primary contact person for this account

getAcceptAvalaraTermsAndConditions

public Boolean getAcceptAvalaraTermsAndConditions()

Getter for acceptAvalaraTermsAndConditions 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.

setAcceptAvalaraTermsAndConditions

public void setAcceptAvalaraTermsAndConditions(Boolean value)

Setter for acceptAvalaraTermsAndConditions 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.

getHaveReadAvalaraTermsAndConditions

public Boolean getHaveReadAvalaraTermsAndConditions()

Getter for haveReadAvalaraTermsAndConditions 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.

setHaveReadAvalaraTermsAndConditions

public void setHaveReadAvalaraTermsAndConditions(Boolean value)

Setter for haveReadAvalaraTermsAndConditions 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.

getMarketingContext

public HashMap<String,String> getMarketingContext()

Getter for marketingContext A dynamic key-value pair for the marketing context information

setMarketingContext

public void setMarketingContext(HashMap<String,String> value)

Setter for marketingContext A dynamic key-value pair for the marketing context information

getAccountType

public AccountTypeId getAccountType()

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

setAccountType

public void setAccountType(AccountTypeId value)

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

getTaxPayerIdNumber

public String getTaxPayerIdNumber()

Getter for taxPayerIdNumber 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.

setTaxPayerIdNumber

public void setTaxPayerIdNumber(String value)

Setter for taxPayerIdNumber 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.

toString

public String toString()

Returns a JSON string representation of NewAccountRequestModel

Overrides:

toString in class Object