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

DynamicRuleInputModel

A Dynamic Rule customizes AvaTax's default tax calculation to match a company's specific requirements. It is composed of modular conditions and actions that can adjust an item's taxability, tax base, and tax rate, modify transaction fields and addresses, allocate or split line items, update location codes, and more.

Parameters
idOptional
integer

Unique integer ID for this rule.

definitionRequired
DynamicRuleDefinitionInputModel

The definition of the rule, which includes its custom variables and execution graph.

nameRequired
string

The name of the rule. Must be unique within a company.

descriptionOptional
string

Optional description of the rule.

effectiveDateRequired
string

The first date at which this rule applies.

endDateRequired
string

The last date for which this rule applies. This must be on or after the effective date for the rule to be valid.

enabledRequired
boolean

Whether the rule is ever allowed to execute.

continueOnErrorRequired
boolean

Whether to continue the transaction if this rule fails. If set to false, a failure will cause the entire transaction to return an error. If set to true, a failure will only stop execution of this rule.

isDraftOptional
boolean

Whether this is a draft rule. Draft rules are not executed on transactions by default. To execute a draft rule, it must be enabled and the TestTransaction endpoint must be used with appropriate settings.

priorityOptional
integer

The execution priority of the rule. Within each execution step, rules are executed in ascending priority order. This means that, within a step, rules with higher values see the effects of and may overwrite the results of rules with lower values.