AvaTax for VAT

OverviewAPI
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

UserModel

An account user who is permitted to use AvaTax.

This model is used in the following APIs:

Parameters
idRequired
integer

The unique ID number of this user.

accountIdRequired
integer

The unique ID number of the account to which this user belongs.

companyIdOptional
integer

If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.

userNameRequired
string

The username which is used to log on to the AvaTax website, or to authenticate against API calls.

firstNameRequired
string

The first or given name of the user.

lastNameRequired
string

The last or family name of the user.

emailRequired
string

The email address to be used to contact this user. If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password.

postalCodeOptional
string

The postal code in which this user resides.

securityRoleIdRequired
string

The security level for this user.

Enum: NoAccess, SiteAdmin, AccountOperator, AccountAdmin, AccountUser, SystemAdmin, Registrar, CSPTester, CSPAdmin, SystemOperator, TechnicalSupportUser, TechnicalSupportAdmin, TreasuryUser, TreasuryAdmin, ComplianceUser, ComplianceAdmin, ProStoresOperator, CompanyUser, CompanyAdmin, ComplianceTempUser, ComplianceRootUser, ComplianceOperator, SSTAdmin, FirmUser, FirmAdmin, BatchServiceAdmin, ECMAccountUser, ECMCompanyUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, AvaTaxOnlyUserAdmin
passwordStatusOptional
string

The status of the user's password. For a new user created, this is always going to be UserMustChange

Enum: UserCannotChange, UserCanChange, UserMustChange
isActiveOptional
boolean

True if this user is currently active.

createdDateOptional
string

The date when this record was created.

modifiedDateOptional
string

The date/time when this record was last modified.

subjectIdOptional
string

Matches the subjectId of corresponding user record in AI.

migratedDateOptional
string

The date/time when this record was migrated to Avalara Identity modified.

suppressNewUserEmailOptional
boolean

Suppress new user email

isDeletedOptional
boolean

A boolean flag to identify if the user is deleted