Package net.avalara.avatax.rest.client.models

Class TaxOverrideModel

java.lang.Object
net.avalara.avatax.rest.client.models.TaxOverrideModel
public class TaxOverrideModel
extends java.lang.Object
Represents a tax override for a transaction

  • Constructor Summary

    Constructors 
    Constructor Description
    TaxOverrideModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getReason()
    Getter for reason This provides the reason for a tax override for audit purposes.
    java.math.BigDecimal getTaxAmount()
    Getter for taxAmount Indicates a total override of the calculated tax on the document.
    java.util.ArrayList<TransactionLineTaxAmountByTaxTypeModel> getTaxAmountByTaxTypes()
    Getter for taxAmountByTaxTypes Indicates a total override of the calculated tax on the line with TaxType.
    java.util.Date getTaxDate()
    Getter for taxDate The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element.
    TaxOverrideType getType()
    Getter for type Identifies the type of tax override
    void setReason​(java.lang.String value)
    Setter for reason This provides the reason for a tax override for audit purposes.
    void setTaxAmount​(java.math.BigDecimal value)
    Setter for taxAmount Indicates a total override of the calculated tax on the document.
    void setTaxAmountByTaxTypes​(java.util.ArrayList<TransactionLineTaxAmountByTaxTypeModel> value)
    Setter for taxAmountByTaxTypes Indicates a total override of the calculated tax on the line with TaxType.
    void setTaxDate​(java.util.Date value)
    Setter for taxDate The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element.
    void setType​(TaxOverrideType value)
    Setter for type Identifies the type of tax override
    java.lang.String toString()
    Returns a JSON string representation of TaxOverrideModel

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • getType

      public TaxOverrideType getType()
      Getter for type Identifies the type of tax override

    • setType

      public void setType​(TaxOverrideType value)
      Setter for type Identifies the type of tax override

    • getTaxAmount

      public java.math.BigDecimal getTaxAmount()
      Getter for taxAmount Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines. Tax will be distributed on a best effort basis. It may not always be possible to override all taxes. Please consult your account manager for information about overrides.

    • setTaxAmount

      public void setTaxAmount​(java.math.BigDecimal value)
      Setter for taxAmount Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines. Tax will be distributed on a best effort basis. It may not always be possible to override all taxes. Please consult your account manager for information about overrides.

    • getTaxDate

      public java.util.Date getTaxDate()
      Getter for taxDate The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element. If the date is not overridden, then it should be set to the same as the DocDate.

    • setTaxDate

      public void setTaxDate​(java.util.Date value)
      Setter for taxDate The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element. If the date is not overridden, then it should be set to the same as the DocDate.

    • getReason

      public java.lang.String getReason()
      Getter for reason This provides the reason for a tax override for audit purposes. It is required for types 2-4. Typical reasons include: "Return" "Layaway"

    • setReason

      public void setReason​(java.lang.String value)
      Setter for reason This provides the reason for a tax override for audit purposes. It is required for types 2-4. Typical reasons include: "Return" "Layaway"

    • getTaxAmountByTaxTypes

      public java.util.ArrayList<TransactionLineTaxAmountByTaxTypeModel> getTaxAmountByTaxTypes()
      Getter for taxAmountByTaxTypes Indicates a total override of the calculated tax on the line with TaxType. AvaTax will distribute the override across all the line details for that TaxType. TaxAmountByTaxType can be used only at the Line level.

    • setTaxAmountByTaxTypes

      public void setTaxAmountByTaxTypes​(java.util.ArrayList<TransactionLineTaxAmountByTaxTypeModel> value)
      Setter for taxAmountByTaxTypes Indicates a total override of the calculated tax on the line with TaxType. AvaTax will distribute the override across all the line details for that TaxType. TaxAmountByTaxType can be used only at the Line level.

    • toString

      public java.lang.String toString()
      Returns a JSON string representation of TaxOverrideModel
      Overrides:
      toString in class java.lang.Object