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

Class TransactionSummary

java.lang.Object
net.avalara.avatax.rest.client.models.TransactionSummary
public class TransactionSummary
extends java.lang.Object
Summary information about an overall transaction.

  • Constructor Summary

    Constructors 
    Constructor Description
    TransactionSummary()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCountry()
    Getter for country Two character ISO-3166 country code.
    java.math.BigDecimal getExemption()
    Getter for exemption The amount of the transaction that was exempt.
    java.lang.String getJurisCode()
    Getter for jurisCode Jurisdiction Code for the taxing jurisdiction
    java.lang.String getJurisName()
    Getter for jurisName The name of the jurisdiction that collects this tax.
    JurisdictionType getJurisType()
    Getter for jurisType The type of jurisdiction that collects this tax.
    java.math.BigDecimal getNonTaxable()
    Getter for nonTaxable The amount of the transaction that was non-taxable.
    java.math.BigDecimal getRate()
    Getter for rate Tax Rate - The rate of taxation, as a fraction of the amount.
    RateType getRateType()
    Getter for rateType DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead.
    java.lang.String getRateTypeCode()
    Getter for rateTypeCode Indicates the code of the rate type.
    java.lang.String getRegion()
    Getter for region Two or three character ISO region, state or province code, if applicable.
    java.lang.String getStateAssignedNo()
    Getter for stateAssignedNo The state assigned number of the jurisdiction that collects this tax.
    java.math.BigDecimal getTax()
    Getter for tax Tax amount - The calculated tax (Base * Rate).
    java.math.BigDecimal getTaxable()
    Getter for taxable Tax Base - The adjusted taxable amount.
    java.lang.Integer getTaxAuthorityType()
    Getter for taxAuthorityType The unique ID of the Tax Authority Type that collects this tax.
    java.math.BigDecimal getTaxCalculated()
    Getter for taxCalculated The amount of tax that AvaTax calculated for the transaction.
    java.lang.String getTaxGroup()
    Getter for taxGroup Group code when special grouping is enabled.
    java.lang.String getTaxName()
    Getter for taxName The name of the tax.
    java.lang.String getTaxSubType()
    Getter for taxSubType The tax subtype of this tax.
    java.lang.String getTaxType()
    Getter for taxType The tax type of this tax.
    void setCountry​(java.lang.String value)
    Setter for country Two character ISO-3166 country code.
    void setExemption​(java.math.BigDecimal value)
    Setter for exemption The amount of the transaction that was exempt.
    void setJurisCode​(java.lang.String value)
    Setter for jurisCode Jurisdiction Code for the taxing jurisdiction
    void setJurisName​(java.lang.String value)
    Setter for jurisName The name of the jurisdiction that collects this tax.
    void setJurisType​(JurisdictionType value)
    Setter for jurisType The type of jurisdiction that collects this tax.
    void setNonTaxable​(java.math.BigDecimal value)
    Setter for nonTaxable The amount of the transaction that was non-taxable.
    void setRate​(java.math.BigDecimal value)
    Setter for rate Tax Rate - The rate of taxation, as a fraction of the amount.
    void setRateType​(RateType value)
    Setter for rateType DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead.
    void setRateTypeCode​(java.lang.String value)
    Setter for rateTypeCode Indicates the code of the rate type.
    void setRegion​(java.lang.String value)
    Setter for region Two or three character ISO region, state or province code, if applicable.
    void setStateAssignedNo​(java.lang.String value)
    Setter for stateAssignedNo The state assigned number of the jurisdiction that collects this tax.
    void setTax​(java.math.BigDecimal value)
    Setter for tax Tax amount - The calculated tax (Base * Rate).
    void setTaxable​(java.math.BigDecimal value)
    Setter for taxable Tax Base - The adjusted taxable amount.
    void setTaxAuthorityType​(java.lang.Integer value)
    Setter for taxAuthorityType The unique ID of the Tax Authority Type that collects this tax.
    void setTaxCalculated​(java.math.BigDecimal value)
    Setter for taxCalculated The amount of tax that AvaTax calculated for the transaction.
    void setTaxGroup​(java.lang.String value)
    Setter for taxGroup Group code when special grouping is enabled.
    void setTaxName​(java.lang.String value)
    Setter for taxName The name of the tax.
    void setTaxSubType​(java.lang.String value)
    Setter for taxSubType The tax subtype of this tax.
    void setTaxType​(java.lang.String value)
    Setter for taxType The tax type of this tax.
    java.lang.String toString()
    Returns a JSON string representation of TransactionSummary

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getCountry

      public java.lang.String getCountry()
      Getter for country Two character ISO-3166 country code.

    • setCountry

      public void setCountry​(java.lang.String value)
      Setter for country Two character ISO-3166 country code.

    • getRegion

      public java.lang.String getRegion()
      Getter for region Two or three character ISO region, state or province code, if applicable.

    • setRegion

      public void setRegion​(java.lang.String value)
      Setter for region Two or three character ISO region, state or province code, if applicable.

    • getJurisType

      public JurisdictionType getJurisType()
      Getter for jurisType The type of jurisdiction that collects this tax.

    • setJurisType

      public void setJurisType​(JurisdictionType value)
      Setter for jurisType The type of jurisdiction that collects this tax.

    • getJurisCode

      public java.lang.String getJurisCode()
      Getter for jurisCode Jurisdiction Code for the taxing jurisdiction

    • setJurisCode

      public void setJurisCode​(java.lang.String value)
      Setter for jurisCode Jurisdiction Code for the taxing jurisdiction

    • getJurisName

      public java.lang.String getJurisName()
      Getter for jurisName The name of the jurisdiction that collects this tax.

    • setJurisName

      public void setJurisName​(java.lang.String value)
      Setter for jurisName The name of the jurisdiction that collects this tax.

    • getTaxAuthorityType

      public java.lang.Integer getTaxAuthorityType()
      Getter for taxAuthorityType The unique ID of the Tax Authority Type that collects this tax.

    • setTaxAuthorityType

      public void setTaxAuthorityType​(java.lang.Integer value)
      Setter for taxAuthorityType The unique ID of the Tax Authority Type that collects this tax.

    • getStateAssignedNo

      public java.lang.String getStateAssignedNo()
      Getter for stateAssignedNo The state assigned number of the jurisdiction that collects this tax.

    • setStateAssignedNo

      public void setStateAssignedNo​(java.lang.String value)
      Setter for stateAssignedNo The state assigned number of the jurisdiction that collects this tax.

    • getTaxType

      public java.lang.String getTaxType()
      Getter for taxType The tax type of this tax.

    • setTaxType

      public void setTaxType​(java.lang.String value)
      Setter for taxType The tax type of this tax.

    • getTaxSubType

      public java.lang.String getTaxSubType()
      Getter for taxSubType The tax subtype of this tax.

    • setTaxSubType

      public void setTaxSubType​(java.lang.String value)
      Setter for taxSubType The tax subtype of this tax.

    • getTaxName

      public java.lang.String getTaxName()
      Getter for taxName The name of the tax.

    • setTaxName

      public void setTaxName​(java.lang.String value)
      Setter for taxName The name of the tax.

    • getTaxGroup

      public java.lang.String getTaxGroup()
      Getter for taxGroup Group code when special grouping is enabled.

    • setTaxGroup

      public void setTaxGroup​(java.lang.String value)
      Setter for taxGroup Group code when special grouping is enabled.

    • getRateType

      public RateType getRateType()
      Getter for rateType DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead. Indicates the tax rate type.

    • setRateType

      public void setRateType​(RateType value)
      Setter for rateType DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead. Indicates the tax rate type.

    • getRateTypeCode

      public java.lang.String getRateTypeCode()
      Getter for rateTypeCode Indicates the code of the rate type. Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes.

    • setRateTypeCode

      public void setRateTypeCode​(java.lang.String value)
      Setter for rateTypeCode Indicates the code of the rate type. Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes.

    • getTaxable

      public java.math.BigDecimal getTaxable()
      Getter for taxable Tax Base - The adjusted taxable amount.

    • setTaxable

      public void setTaxable​(java.math.BigDecimal value)
      Setter for taxable Tax Base - The adjusted taxable amount.

    • getRate

      public java.math.BigDecimal getRate()
      Getter for rate Tax Rate - The rate of taxation, as a fraction of the amount.

    • setRate

      public void setRate​(java.math.BigDecimal value)
      Setter for rate Tax Rate - The rate of taxation, as a fraction of the amount.

    • getTax

      public java.math.BigDecimal getTax()
      Getter for tax Tax amount - The calculated tax (Base * Rate).

    • setTax

      public void setTax​(java.math.BigDecimal value)
      Setter for tax Tax amount - The calculated tax (Base * Rate).

    • getTaxCalculated

      public java.math.BigDecimal getTaxCalculated()
      Getter for taxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `TaxCalculated` field which represents the amount of tax that AvaTax calculated for this transaction without override. You can use this for comparison.

    • setTaxCalculated

      public void setTaxCalculated​(java.math.BigDecimal value)
      Setter for taxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `TaxCalculated` field which represents the amount of tax that AvaTax calculated for this transaction without override. You can use this for comparison.

    • getNonTaxable

      public java.math.BigDecimal getNonTaxable()
      Getter for nonTaxable The amount of the transaction that was non-taxable.

    • setNonTaxable

      public void setNonTaxable​(java.math.BigDecimal value)
      Setter for nonTaxable The amount of the transaction that was non-taxable.

    • getExemption

      public java.math.BigDecimal getExemption()
      Getter for exemption The amount of the transaction that was exempt.

    • setExemption

      public void setExemption​(java.math.BigDecimal value)
      Setter for exemption The amount of the transaction that was exempt.

    • toString

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