AvaTax for VAT

OverviewAPI
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

CustomTaxRateInputModel

Describes a single rate override row for a custom tax.
This is the input variant used when creating or updating a custom tax. Each rate row specifies a rate and a set of optional criteria (jurisdiction, tax code, tariff code, entity use code, etc.) which determine when the rate applies.

Parameters
rateRequired
number

The rate which is assigned based on the criteria in this model. The value is interpreted according to the custom tax's unitOfBasis (for example, a value of 0.05 with PerCurrencyUnit means 5%).

capOptional
number

Optionally specify the maximum taxable amount. Any portion of the base above this cap is not taxed at this rate.

thresholdOptional
number

Optionally specify the per-unit threshold that must be met to apply this rate. If the line amount is below the threshold this rate does not apply.

jurisdictionTypeIdOptional
string

Optionally set the type of jurisdiction this rate applies to, e.g. State or City. When specified together with jurisCode, this rate only applies to transactions sourced to matching jurisdictions.

Enum: Country, State, County, City, Special
jurisCodeOptional
string

Optionally set the specific jurisdiction this rate applies to. This should be one of the jurisdictions defined on the parent custom tax.

rateTypeCodeOptional
string

The rate type for which this rate applies.

taxCodeOptional
string

Optionally set a specific tax code this rate applies to. Tax codes identify product or service categories for taxation.

tariffCodeOptional
string

Optionally set a specific tariff code this rate applies to. Tariff codes are used for cross-border and customs taxation.

entityUseCodeOptional
string

Optionally set a specific entity use code this rate applies to. Entity use codes describe customer usage such as resale, manufacturing, or government use.

effectiveDateOptional
string

Optionally set a different effective date for this rate. This date cannot be earlier than the base effective date set for the entire custom tax.

endDateOptional
string

Optionally set a different expiration date for this rate. This date cannot be later than the base expiration date set for the entire custom tax.

currencyCodeOptional
string

Optionally set the currency code to use for this rate. When omitted, the rate uses the transaction's currency.

unitOfBasisOptional
string

Optionally override the unit of basis for this specific rate. If not specified, the rate uses the custom tax default unit of basis.

isAllJurisOptional
boolean

Whether this rate applies to all child jurisdictions or only the specified one. When true, the rate is applied to every jurisdiction beneath the one identified by jurisCode; when false or null, only the exact jurisdiction is matched.

optionsOptional
array

Optional advanced settings for this rate. The allowed values depend on the tax type and are documented separately.