net.avalara.avatax.rest.client.enums

Enum TaxRuleTypeId

java.lang.Object

java.lang.Enum<TaxRuleTypeId>

net.avalara.avatax.rest.client.enums.TaxRuleTypeId

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaxRuleTypeId>

public enum TaxRuleTypeId
extends java.lang.Enum<TaxRuleTypeId>

Specifies the type of custom tax rule you have created.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BaseRule Specifies a rule that changes the tax base of a specific product.
ExemptEntityRule Indicates that a particular product is exempt from tax due to an exempt usage reason.
NexusRule Reserved for Avalara internal usage.
ProductTaxabilityRule Specifies a rule that changes whether a product is taxable or not.
RateOverrideRule Specifies a rule that changes the rate of tax for a specified set of criteria.
RateRule Reserved for Avalara internal usage.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static TaxRuleTypeId	valueOf(int intValue)
static TaxRuleTypeId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TaxRuleTypeId[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RateRule

public static final TaxRuleTypeId RateRule

Reserved for Avalara internal usage.

RateOverrideRule

public static final TaxRuleTypeId RateOverrideRule

Specifies a rule that changes the rate of tax for a specified set of criteria. This rule can apply to one specific type of product (identified by `TaxCode`) or all products (identified by a null `TaxCode`).

BaseRule

public static final TaxRuleTypeId BaseRule

Specifies a rule that changes the tax base of a specific product. This rule can apply to one specific type of product (identified by `TaxCode`) or all products (identified by a null `TaxCode`).

ExemptEntityRule

public static final TaxRuleTypeId ExemptEntityRule

Indicates that a particular product is exempt from tax due to an exempt usage reason. Amounts exempted by this rule are stored in the `exemptAmount` field on the transaction.

ProductTaxabilityRule

public static final TaxRuleTypeId ProductTaxabilityRule

Specifies a rule that changes whether a product is taxable or not. This rule must be applied to a specific type of product. If you attempt to create a product taxability rule while leaving the `TaxCode` and `TaxCodeId` fields empty, you will get an error. A `value` field of `1` means that this tax code is taxable; `0` means it is nontaxable. Amounts that are considered not taxable according to this rule are stored in the `nonTaxableAmount` column in a transaction. This type of rule can also determine the rate type for a product or to apply a cap or threshold.

NexusRule

public static final TaxRuleTypeId NexusRule

Reserved for Avalara internal usage.

Method Detail

values

public static TaxRuleTypeId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TaxRuleTypeId c : TaxRuleTypeId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TaxRuleTypeId valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOf

public static TaxRuleTypeId valueOf(int intValue)

getValue

public int getValue()