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

CustomTaxTaxabilityOutputModel

Describes a single taxability override row for a custom tax.
This is the output variant returned by Custom Tax read endpoints. Each taxability row defines whether an item is taxable or not, optionally scoped to a specific jurisdiction, tax code, tariff code, or entity use code.

Parameters
taxableOptional
boolean

Whether this tax treatment sets an item as taxable or not taxable. When true, items matching the other criteria are taxable under this custom tax; when false, they are explicitly marked as not taxable.

capOptional
number

Optionally specify the maximum taxable amount. Any portion of the base above this cap is not taxed under this taxability treatment.

thresholdOptional
number

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

jurisdictionTypeIdOptional
string

Optionally set the type of jurisdiction this tax treatment applies to, e.g. State or City. When combined with jurisCode, the taxability is scoped to the matching jurisdiction only.

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

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

rateTypeCodeOptional
string

The rate type to assign as part of this tax treatment.

taxCodeOptional
string

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

tariffCodeOptional
string

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

entityUseCodeOptional
string

Optionally set a specific entity use code this tax treatment 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 tax treatment. 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 tax treatment. 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 tax treatment.

isAllJurisOptional
boolean

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

sourcingOptional
string

Optionally override the sourcing to Origin, Destination, or blank (default). Sourcing controls which location of the transaction (origin or destination) is used to evaluate this tax treatment.

optionsOptional
array

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