AvaTax for VAT

Overview API

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

DynamicRuleComponentDefinitionModel

Represents the definition and schema of a Dynamic Rule component.

Parameters

typeOptional

string

The primary type of the component, determining its role in the rule execution. This is typically one of the following: Condition, Action, or Variable.

Enum: Unknown, Condition, Action, Variable

subtypeOptional

string

The specific subtype of the component, providing more detailed classification within the main type. For example, a Condition type might have subtypes like MatchCustomerCode, MatchProductCode, etc. The subtype determines the expected format of the data property.

Enum: Unknown, Condition, MatchExpression, MatchField, MatchCustomerCode, MatchDocumentType, MatchUserDefinedField, MatchParameter, MatchTaxOverride, MatchAddress, MatchTariffCode, MatchTaxCode, MatchTax, CustomTax, MatchJurisdiction, MatchEntityUseCode, MatchMessage, Action, UpdateField, CopyField, UpdateAddress, CopyAddress, UpdateParameter, UpdateUserDefinedField, UpdateTaxOverride, UpdateLocationCode, UpdateMarketplace, AllocateByField, AllocateByAddress, AllocateConsumerUse, AggregateLines, TaxRuleRateOverride, TaxRuleBaseOverride, TaxRuleProductTaxability, TaxRuleExemptEntity, AddMessage, AddLine, Variable, Expression, Aggregation

nameOptional

string

Display name of this component

descriptionOptional

string

A description of the component's purpose and usage

dataSchemaOptional

string

The JSON schema defining the component's configuration structure, as a string

validStepsOptional

array

The execution steps in which the component is usable

requiresOptional

array

Array of node subtypes which are required to be present when this node type is present