AvaTax
CustomTaxRateInputModel
Describes a single rate override row for a custom tax.
Pattern matching is performed on the optional criteria to map rate values to jurisdictions,
where omitted values are treated as wildcards.
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.
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%).
Optionally specify the maximum taxable amount. Any portion of the base above this cap is not taxed at this rate.
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.
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.
Optionally set the specific jurisdiction this rate applies to. This should be one of the jurisdictions defined on the parent custom tax.
The rate type for which this rate applies.
Optionally set a specific tax code this rate applies to. Tax codes identify product or service categories for taxation.
Optionally set a specific tariff code this rate applies to. Tariff codes are used for cross-border and customs taxation.
Optionally set a specific entity use code this rate applies to. Entity use codes describe customer usage such as resale, manufacturing, or government use.
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.
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.
Optionally set the currency code to use for this rate. When omitted, the rate uses the transaction's currency.
Optionally override the unit of basis for this specific rate. If not specified, the rate uses the custom tax default unit of basis.
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.
Optional advanced settings for this rate. The allowed values depend on the tax type and are documented separately.