AvaTax for VAT
CustomTaxInputModel
A Custom Tax represents a tax-rate / taxability / exemption package owned by a single
company. It is a type of Custom Rule that exposes a focused, content-oriented shape for
callers who want to manage tax overrides without constructing a Custom Rule by hand.
Use of the Custom Tax endpoints requires the AvaCustomContent subscription.
This is the input variant used when creating or updating a Custom Tax via the
CreateCustomTax, UpdateCustomTax, or ValidateCustomTax endpoints. Any
fields that are populated only by the system (such as id, companyId, and the
created/modified audit fields) are excluded from this model and live on
CustomTaxOutputModel instead.
The name of the custom tax. Displayed in UI surfaces and used to identify the custom tax when reviewing rules for a company.
Optional description of the custom tax. Intended for use by compliance and support teams to document the intent or source of the rule.
The country in which the custom tax applies. This is typically an ISO 3166-1 alpha-2
country code such as US or CA.
The region or state in which the custom tax applies. The expected value depends on
country; for the United States this is typically the two-letter state
abbreviation such as WA.
The tax type for this custom tax.
The tax subtype for this custom tax. Subtypes typically mirror the tax type but may be customized to describe more granular categories.
The rate types associated with this custom tax.
The default unit of basis used to calculate the value of this custom tax. Determines
how the rate on each rate row is interpreted — for example, PerCurrencyUnit for
a percentage or PerUnit for a flat amount per unit.
The start date when the tax is valid. Transactions with a document date earlier than this date will not be affected by this custom tax.
The end date when the tax is valid. Transactions with a document date later than this date will not be affected by this custom tax.
Whether the custom tax is enabled. When false, the tax is persisted but is not evaluated during tax calculation.
Whether to continue execution if there is an error evaluating the rule criteria. When true, an error in this custom tax does not stop evaluation of other custom taxes or custom rules on the transaction.
A list of jurisdictions in which this custom tax applies. At least one jurisdiction is required; each jurisdiction identifies a region of applicability for the tax.
Optional additional criteria for when this custom tax should apply. When provided, the custom tax is only evaluated on transactions that satisfy these conditions; refer to the additional-criteria model for the supported component shape.
Define the taxability treatment and rate type assignment for this custom tax. Taxability rows express default and override behaviour for items the tax applies to.
Define the tax rates associated with this custom tax. Each rate row specifies the numeric rate and the criteria under which that rate applies.
Optional list of when items are exempt from this custom tax. Each exemption row defines criteria that mark matching transaction lines as exempt (or explicitly not exempt).