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

CreateCustomRulesBatchRequestModel

Represents a create Custom Rules import batch request model. The payload is the Custom Rules export envelope (tax rules, dynamic rules, and advanced rules) which is stored as JSON in S3 and processed downstream by BatchV2.

Parameters
nameOptional
string

The user-friendly readable name for this batch. Optional - when omitted it is derived from Avalara.AvaTax.AccountServices.Models.v2.CreateCustomRulesBatchRequestModel.kind and Avalara.AvaTax.AccountServices.Models.v2.CreateCustomRulesBatchRequestModel.exportedAt.

kindOptional
string

The kind of export this payload represents (e.g. "CustomRulesExport").

schemaVersionOptional
string

The schema version of the export payload.

exportedAtOptional
string

The UTC timestamp when the source rules were exported.

exportedByOptional
CustomRuleExportUser

Information about the user who produced the export.

sourceAccountIdOptional
integer

The account the rules were exported from.

sourceCompanyIdOptional
integer

The company the rules were exported from.

filterOptional
string

The overall filter used to produce the export, if any.

taxRuleFilterOptional
string

The tax-rule-specific filter used to produce the export, if any.

advancedRuleFilterOptional
string

The advanced-rule-specific filter used to produce the export, if any.

dynamicRuleFilterOptional
string

The dynamic-rule-specific filter used to produce the export, if any.

orderByOptional
string

The order-by clause used to produce the export, if any.

topOptional
integer

The page size used when producing the export.

skipOptional
integer

The number of records skipped when producing the export.

totalCountOptional
integer

The total number of rules contained in this payload.

taxRuleCountOptional
integer

The number of traditional tax rules contained in this payload.

dynamicRuleCountOptional
integer

The number of dynamic rules contained in this payload.

advancedRuleCountOptional
integer

The number of advanced rules contained in this payload.

taxRulesOptional
array

The traditional tax rules to import. Stored verbatim so downstream processing receives the exact exported shape.

dynamicRulesOptional
array

The dynamic (graph-based) rules to import. Stored verbatim so downstream processing receives the exact exported shape.

advancedRulesOptional
array

The advanced rules to import. Stored verbatim so downstream processing receives the exact exported shape.