AvaTax
CustomTaxOutputModel
A Custom Tax defines company-specific tax content — the jurisdictions where a tax applies together with its
rates, taxability, and exemptions. It provides a focused, content-oriented way to author and manage tax
overrides for a company.
Use of the Custom Tax endpoints requires the AvaCustomContent subscription.
Unique identifier for this custom tax. Equal to the underlying Custom Rule ID.
The ID of the company that owns this custom tax.
The name of the custom tax.
Optional description of the custom tax. Intended for use by compliance and support teams to document intent or source.
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 of the custom tax.
The tax subtype for this custom tax, which describes a more granular tax category within the main type.
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 first date when the tax is valid. Transactions with a document date earlier than this date will not be affected by this custom tax.
The last 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 will not be calculated. Existing saved documents are not affected.
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. When false, a failure will cause the entire transaction to return an error.
A list of jurisdictions in which this custom tax applies. At least one jurisdiction is required; each jurisdiction identifies a place 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).
The date when the custom tax was created.
The ID of the user who created the custom tax.
The date when the custom tax was last modified.
The ID of the user who last modified the custom tax.