AvaTax

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

ParameterModel

An extra property that can change the behavior of tax transactions.

Parameters
idOptional
integer

The unique ID number of this property.

categoryOptional
string

DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The category grouping of this parameter. When your user interface displays a large number of parameters, they should be grouped by their category value.

nameOptional
string

The name of the property. To use this property, add a field on the parameters object of a CreateTransaction call.

dataTypeOptional
string

The data type of the property.

helpTextOptional
string

Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.

serviceTypesOptional
array

A list of service types to which this parameter applies.

promptOptional
string

DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The prompt you should use when displaying this parameter to a user. For example, if your user interface displays a parameter in a text box, this is the label you should use to identify that text box.

regularExpressionOptional
string

DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. If your user interface permits client-side validation of parameters, this string is a regular expression you can use to validate the user's data entry prior to submitting a tax request.

labelOptional
string

Label that helps the user to identify a parameter

helpUrlOptional
string

A help url that provides more information about the parameter

attributeTypeOptional
string

The type of parameter as determined by its application, e.g. Product, Transaction, Calculated

attributeSubTypeOptional
string

The sub-type of parameter as determined by its application.

valuesOptional
array

If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.

measurementTypeOptional
string

The unit of measurement type of the parameter

isNeededForCalculationOptional
boolean

This field identifies if parameter is needed for calculation

isNeededForReturnsOptional
boolean

This field identifies if parameter is needed for returns

isNeededForClassificationOptional
boolean

This field identifies if parameter is needed for classification