Enum TaxOverrideType
- All Implemented Interfaces:
Serializable,Comparable<TaxOverrideType>,java.lang.constant.Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionTo support Consumer Use TaxDerive the taxable amount from the tax amountEntity exemption was ignored (e.g.AvaTax calculated the tax for this transaction, and no override occurred.This is for the documents that are calculated outside of AvaTax and passed in to AvaTax specifically for reporting/Returns purposesAvaTax calculated tax for this transaction, but the final tax amount on the transaction was determined outside of AvaTax.To support Tax Override Amount with Tax Type featureAvaTax was instructed to calculate this transaction using the tax rules that were in effect on a different day than the transaction occurred.To support ACU transaction -
Method Summary
Modifier and TypeMethodDescriptionintgetValue()static TaxOverrideTypevalueOf(int intValue) Returns the enum constant of this type with the specified name.static TaxOverrideTypeReturns 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.
-
Enum Constant Details
-
None
AvaTax calculated the tax for this transaction, and no override occurred. -
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
Entity exemption was ignored (e.g. item was consumed) -
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
To support Consumer Use Tax -
DeriveTaxable
Derive the taxable amount from the tax amount -
OutOfHarbor
This is for the documents that are calculated outside of AvaTax and passed in to AvaTax specifically for reporting/Returns purposes -
TaxAmountByTaxType
To support Tax Override Amount with Tax Type feature -
VendorChargedTax
To support ACU transaction
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
valueOf
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:
intValue- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getValue
public int getValue()
-