Exemption Certificate Management

CertCapture RESTful APIs

DynamicRuleComponentOutputModel

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

idOptional

string

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

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

dataOptional

string

JSON-formatted string containing the configuration data for the component. The structure of this data varies based on the component type and subtype. For example, a MatchCustomerCode condition might contain an array of customer codes to match against.

nextOptional

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.