AvaTax

OverviewAPISDKMCP
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

DynamicRuleComponentInputModel

Represents a component within a Dynamic Rule definition. Components define the logic and flow of a rule, and include condition nodes, action nodes, and rule-wide variables.

Parameters
idRequired
string

Unique identifier for the component. This ID is used to reference the component and establish connections between components via the 'next' property.

typeRequired
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
subtypeRequired
string

The specific subtype of the component, which describes the specific behavior of the component within the main type. For example, MatchField is a subtype of Condition, and UpdateField is a subtype of Action. 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
dataRequired
string

Escaped JSON-formatted string containing the configuration data for the component. The structure of this data varies based on the component type and subtype. Use the GetDynamicRuleComponents endpoint to retrieve the expected schema by subtype.

nextRequired
array

Array of component IDs that represent the next components in the rule execution flow. This property defines the outgoing edges in the rule graph, allowing for conditional branching and sequential processing of components.