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

Class TransactionSummary

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

  • Constructor Details

    • TransactionSummary

      public TransactionSummary()

  • Method Details

    • getCountry

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

    • setCountry

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

    • getRegion

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

    • setRegion

      public void setRegion(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 String getJurisCode()
      Getter for jurisCode Jurisdiction Code for the taxing jurisdiction

    • setJurisCode

      public void setJurisCode(String value)
      Setter for jurisCode Jurisdiction Code for the taxing jurisdiction

    • getJurisName

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

    • setJurisName

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

    • getTaxAuthorityType

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

    • setTaxAuthorityType

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

    • getStateAssignedNo

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

    • setStateAssignedNo

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

    • getTaxType

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

    • setTaxType

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

    • getTaxSubType

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

    • setTaxSubType

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

    • getTaxName

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

    • setTaxName

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

    • getTaxGroup

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

    • setTaxGroup

      public void setTaxGroup(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 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(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 BigDecimal getTaxable()
      Getter for taxable Tax Base - The adjusted taxable amount.

    • setTaxable

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

    • getRate

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

    • setRate

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

    • getTax

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

    • setTax

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

    • getTaxCalculated

      public 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(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 BigDecimal getNonTaxable()
      Getter for nonTaxable The amount of the transaction that was non-taxable.

    • setNonTaxable

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

    • getExemption

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

    • setExemption

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

    • toString

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