net.avalara.avatax.rest.client.enums

Enum TaxOverrideType

java.lang.Object

java.lang.Enum<TaxOverrideType>

net.avalara.avatax.rest.client.enums.TaxOverrideType

All Implemented Interfaces:

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

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

Represents a type of tax override requested by the customer. AvaTax allows customers to override some behavior of the AvaTax engine. When you use a Tax Override, you can import tax that was previously calculated and charged to the customer exactly as it was charged. AvaTax will record the type of override used for each transaction.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AccruedTaxAmount To support Consumer Use Tax
DeriveTaxable Derive the taxable amount from the tax amount
Exemption Entity exemption was ignored (e.g.
None AvaTax calculated the tax for this transaction, and no override occurred.
OutOfHarbor This is for the documents that are calculated outside of AvaTax and passed in to AvaTax specifically for reporting/Returns purposes
TaxAmount AvaTax calculated tax for this transaction, but the final tax amount on the transaction was determined outside of AvaTax.
TaxDate AvaTax was instructed to calculate this transaction using the tax rules that were in effect on a different day than the transaction occurred.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static TaxOverrideType	valueOf(int intValue)
static TaxOverrideType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TaxOverrideType[]	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

None

public static final TaxOverrideType None

AvaTax calculated the tax for this transaction, and no override occurred.

TaxAmount

public static final TaxOverrideType TaxAmount

AvaTax calculated tax for this transaction, but the final tax amount on the transaction was determined outside of AvaTax. To see the tax amounts determined by AvaTax, look at the `taxCalculated` field. To see the tax amounts determined by the customer's outside tax engine, look at the `taxAmount` field. This behavior can also occur when a customer requests a refund. For refunds calculated using the `RefundTransaction` API, AvaTax will ensure that the exact tax charged to the customer is refunded to the customer using a tax amount override.

Exemption

public static final TaxOverrideType Exemption

Entity exemption was ignored (e.g. item was consumed)

TaxDate

public static final TaxOverrideType TaxDate

AvaTax was instructed to calculate this transaction using the tax rules that were in effect on a different day than the transaction occurred. This behavior typically occurs during refunds. If the customer attempts to return a product without a receipt that shows the exact tax amount paid, AvaTax can calculate tax on the date when they believed that the product was purchased.

AccruedTaxAmount

public static final TaxOverrideType AccruedTaxAmount

To support Consumer Use Tax

DeriveTaxable

public static final TaxOverrideType DeriveTaxable

Derive the taxable amount from the tax amount

OutOfHarbor

public static final TaxOverrideType OutOfHarbor

This is for the documents that are calculated outside of AvaTax and passed in to AvaTax specifically for reporting/Returns purposes

Method Detail

values

public static TaxOverrideType[] 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 (TaxOverrideType c : TaxOverrideType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TaxOverrideType 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 TaxOverrideType valueOf(int intValue)

getValue

public int getValue()