AvaTax for VAT

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

CustomRuleSummaryModel

Model which can provide a summary of any custom rule variety. Custom rules is the umbrella term for traditional Tax Rules, legacy Advanced Rules (transaction rules), and the newest Dynamic Rules.

Parameters
idOptional
string

The unique identifier for this custom rule.

companyIdOptional
integer

The company ID that the custom rule belongs to.

nameOptional
string

The name of the custom rule.

statusOptional
string

The status of the custom rule.

Enum: Unknown, Active, Inactive, Expired, Future, Draft
typeOptional
string

The type of rule entity which this custom rule is.

Enum: Unknown, TaxRule, AdvancedRule, DynamicRule
subtypeOptional
string

The subtypes (categories or actions) of the custom rule.

Enum: Unknown, ProductTaxabilityRule, ExemptEntityRule, RateOverrideRule, BaseOverrideRule, Marketplace, BundledItemsAllocation, MultiplePointsOfUseAllocation, FindAndReplaceBeforeCalculation, FindAndReplaceAfterCalculation, ReportingLocation, SellerRemitsAggregator, ConsumerUseAllocation, FindAndReplaceJurisdictionMatch, UpdateField, CopyField, UpdateAddress, CopyAddress, UpdateParameter, UpdateUserDefinedField, UpdateTaxOverride, UpdateLocationCode, UpdateMarketplace, AllocateByField, AllocateByAddress, AllocateConsumerUse, AggregateLines, TaxRuleRateOverride, TaxRuleBaseOverride, TaxRuleProductTaxability, TaxRuleExemptEntity, CustomTax
subtypeDescriptionOptional
array

The description of the subtypes of the custom rule.

countryOptional
array

Name or ISO 3166 codes identifying the region where this rule will apply.

regionOptional
array

Name or ISO 3166 code identifying the country where this rule will apply.

jurisdictionTypeIdOptional
string

The type(s) of the jurisdiction(s) to which this rule applies.

Enum: Country, State, County, City, Special
jurisNameOptional
array

The name(s) of the jurisdiction(s) to which this rule applies.

jurisCodeOptional
array

The code(s) of the jurisdiction(s) to which this rule applies.

taxCodeOptional
array

For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.

taxTypeOptional
array

Indicates the codes of the tax type that this rule applies to.

taxSubTypeOptional
array

Indicates the codes of the tax sub types that this rule applies to.

rateTypeCodeOptional
array

Indicates the rate types that this rule applies to.

entityUseCodeOptional
array

The entity use code to which this rule applies.

companyLocationCodeOptional
array

The company location codes to which this rule is associated with.

orderOptional
integer

The index order of the rule execution (only applies to advanced rules).

effectiveDateOptional
string

The first date at which this rule applies. If null, this rule will apply to all dates prior to the end date.

endDateOptional
string

The last date for which this rule applies. If null, this rule will apply to all dates after the effective date.

modifiedDateOptional
string

The date the rule was last modified.

createdDateOptional
string

The date the rule was created.

ruleEntityOptional
object

The rule entity data, which can be either a TaxRuleModel, a DynamicRuleModel, or an AdvancedRuleExecutionModel.