The unique ID number of this tax rule.

The unique ID number of the company that owns this tax rule.

For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.

You can choose to specify a tax code either by passing its unique ID number in the taxCodeId field or by passing its alphanumeric code in the taxCode field. To search for the appropriate tax code for your custom rule, use the ListTaxCodes API.

The RateOverrideRule, BaseRule, and ExemptEntityRule rule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank.

The ProductTaxabilityRule rule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message.

For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule.

You can choose to specify a tax code either by passing its unique ID number in the taxCodeId field or by passing its alphanumeric code in the taxCode field. To search for the appropriate tax code for your custom rule, use the ListTaxCodes API.

The RateOverrideRule, BaseRule, and ExemptEntityRule rule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank.

The ProductTaxabilityRule rule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message.

For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.

This field is required for rules that apply to specific jurisdictions in the United States. It is not required if you set the isAllJuris flag to true.

The name of the jurisdiction to which this tax rule applies.

Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the ListJurisdictions API or the ListJurisdictionsByAddress API. To set a rule that applies to all jurisdictions of a specific type, see isAllJuris.

Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the jurisName, jurisCode, and jurisdictionTypeId fields using the information you retrieved from the API above.

The code of the jurisdiction to which this tax rule applies.

Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the ListJurisdictions API or the ListJurisdictionsByAddress API.

Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the jurisName, jurisCode, and jurisdictionTypeId fields using the information you retrieved from the API above.

DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead.

The type of the jurisdiction to which this tax rule applies.

Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the ListJurisdictions API or the ListJurisdictionsByAddress API.

Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the jurisName, jurisCode, and jurisdictionTypeId fields using the information you retrieved from the API above.

To make a custom tax rule for US or Canada that applies to all jurisdictions of a specific type, see the isAllJuris field for more information.

DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.

The entity use code to which this rule applies.

You can create custom entityUseCode values with specific behavior using this API, or you can change the behavior of Avalara's system-defined entity use codes.

For a full list of Avalara-defined entity use codes, see the ListEntityUseCodes API.

DEPRECATED - Date: 09/30/2021, Version: 21.9.0, Message: Please use taxTypeCode instead. Some tax type groups contain multiple different types of tax. To create a rule that affects only one type of tax within a tax type group, set this value to the code matching the specific tax type within that group. The custom tax rule will then only apply to taxes calculated for that specific type.

For rules that affect all tax types, use the value A to match All tax types within that group.

Indicates the code of the tax type that applies to this rule. Use /api/v2/definitions/taxtypes endpoint to retrieve the list of tax types applicable for your company.

TaxRule Product Detail indicates the HSCode(s) to which the tax rule applies.

DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: Please use rateTypeCode, taxTypeGroup and subTaxType instead.

Indicates the code of the rate type that applies to this rule. Use ListRateTypesByCountry API for a full list of rate type codes.

If you specify a value in the rateTypeCode field, this rule will cause tax lines that are affected by the rule to change to a different rate type code.

This type value determines the behavior of the tax rule.

You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate (for example, if you have been granted an official ruling for your product's rate that differs from the official rate), or other types of behavior.

Allows you to make tax rules apply to lower jurisdictions. This feature is only available in the United States and Canada.

• In the United States, this value can be used for rules written at the State jurisdictional level. If set to true, this rule will at the state level, county level, city level, and special jurisdiction level.
• In Canada, this value can be used for rules written at the Country or State jurisdictional levels. If set to true, this rule will at all lower jurisdictional levels.

For any other use case, this value must be false.

This field has different behavior based on the type of the tax rule.

• For a product taxability rule, this value is either 1 or 0, indicating taxable or non-taxable.
• For a rate override rule, this value is the corrected rate stored as a decimal, for example, a rate of 5% would be stored as 0.05 decimal. If you use the special value of 1.0, only the cap and threshold values will be applied and the rate will be left alone.

The maximum cap for the price of this item according to this rule. Any amount above this cap will not be subject to this rule.

For example, if you must pay 5% of a product's value up to a maximum value of $1000, you would set the cap to 1000.00 and the value to 0.05.

The per-unit threshold that must be met before this rule applies.

For example, if your product is nontaxable unless it is above $100 per product, you would set the threshold value to 100. In this case, the rate for the rule would apply to the entire amount above $100.

You can also create rules that make the entire product taxable if it exceeds a threshold, but is nontaxable if it is below the threshold. To choose this, set the options field to the value TaxAll.

Supports custom options for your tax rule.

Supported options include:

• TaxAll - This value indicates that the entire amount of the line becomes taxable when the line amount exceeds the threshold.

The first date at which this rule applies. If null, this rule will apply to all dates prior to the end date.

The last date for which this rule applies. If null, this rule will apply to all dates after the effective date.

A friendly name for this tax rule.

For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.

This field is required for rules that apply to specific jurisdictions in the United States. It is not required if you set the isAllJuris flag to true.

DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: This field is no longer required.

Name or ISO 3166 code identifying the country where this rule will apply.

This field supports many different country identifiers:

• Two character ISO 3166 codes
• Three character ISO 3166 codes
• Fully spelled out names of the country in ISO supported languages
• Common alternative spellings for many countries

For a full list of all supported codes and names, please see the Definitions API ListCountries.

Name or ISO 3166 code identifying the region where this rule will apply.

This field supports many different region identifiers:

• Two and three character ISO 3166 region codes
• Fully spelled out names of the region in ISO supported languages
• Common alternative spellings for many regions

For a full list of all supported codes and names, please see the Definitions API ListRegions. NOTE: Region is required for US and not required for non-US countries because the user may be either creating a Country-level or Region-level rule.

The sourcing types to which this rule applies.

This field has different behavior based on the type of rule.

• For a product taxability rule, if the rule applies to an item, this value will override the tax type group of the original product.
• For other rules, this value determines what tax type groups will be affected by the rule.

Refer to ListTaxTypeGroups for a list of tax type groups supported by AvaTax.

This field has different behavior based on the type of rule.

• For a product taxability rule, if the rule applies to an item, this value will override the tax sub type of the original product.
• For other rules, this value determines what tax sub types will be affected by the rule.

Refer to ListTaxSubtypes for a list of tax sub types supported by AvaTax.

Reserved for Avalara internal usage. Leave this field null.

The currency code to use for this rule.

For a list of currencies supported by AvaTax, use the ListCurrencies API.

Reserved for Avalara internal usage. Leave this field null.

For tax rules that are calculated using units of measurement, this indicates the unit of measurement type used to calculate the amounts for this rule.

For a list of units of measurement, use the ListUnitsOfMeasurement API.

The date when this record was created.

The User ID of the user who created this record.

The date/time when this record was last modified.

The user ID of the user who last modified this record.

The UnitOfBasis for the TaxRule