Class JurisdictionHierarchyModel


  • public class JurisdictionHierarchyModel
    extends java.lang.Object
    Represents information about a single legal taxing jurisdiction with parent jurisdiction
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCity()
      Getter for city The city name of this jurisdiction
      java.lang.String getCode()
      Getter for code The code that is used to identify this jurisdiction
      java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country of this jurisdiction.
      java.lang.String getCounty()
      Getter for county The county name of this jurisdiction
      java.lang.String getCountyFips()
      Getter for countyFips County FIPS code
      java.util.Date getCreateDate()
      Getter for createDate The CreateDate specific to this jurisdiction.
      java.util.Date getEffectiveDate()
      Getter for effectiveDate The date this jurisdiction starts to take effect on tax calculations
      java.util.Date getEndDate()
      Getter for endDate The date this jurisdiction stops to take effect on tax calculations
      java.lang.Integer getId()
      Getter for id Unique AvaTax Id of this Jurisdiction
      java.lang.Boolean getIsAcm()
      Getter for isAcm The isAcm specific to this jurisdiction.
      java.lang.Boolean getIsLocalAdmin()
      Getter for isLocalAdmin IsLocalAdmin.
      java.lang.Boolean getIsSst()
      Getter for isSst The isSst specific to this jurisdiction.
      java.util.Date getModifiedDate()
      Getter for modifiedDate ModifiedDate
      java.lang.String getName()
      Getter for name The name of this jurisdiction
      java.util.ArrayList<JurisdictionNexusModel> getNexus()
      Getter for nexus List of Nexus details associated with the jurisdiction
      java.lang.Integer getParentId()
      Getter for parentId ParentId of the Jurisdiction
      java.lang.String getPlaceFips()
      Getter for placeFips City FIPS code
      java.math.BigDecimal getRate()
      Getter for rate The base rate of tax specific to this jurisdiction.
      java.lang.String getRegion()
      Getter for region Name or ISO 3166 code identifying the region within the country.
      java.math.BigDecimal getSalesRate()
      Getter for salesRate The "Sales" tax rate specific to this jurisdiction.
      java.lang.String getShortName()
      Getter for shortName A short name of the jurisidiction
      java.lang.String getSignatureCode()
      Getter for signatureCode The Avalara-supplied signature code for this jurisdiction.
      java.lang.String getStateFips()
      Getter for stateFips State FIPS code
      java.lang.Integer getTaxAuthorityTypeId()
      Getter for taxAuthorityTypeId TaxAuthorityTypeId.
      JurisdictionType getType()
      Getter for type The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
      java.math.BigDecimal getUseRate()
      Getter for useRate The "Seller's Use" tax rate specific to this jurisdiction.
      void setCity​(java.lang.String value)
      Setter for city The city name of this jurisdiction
      void setCode​(java.lang.String value)
      Setter for code The code that is used to identify this jurisdiction
      void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country of this jurisdiction.
      void setCounty​(java.lang.String value)
      Setter for county The county name of this jurisdiction
      void setCountyFips​(java.lang.String value)
      Setter for countyFips County FIPS code
      void setCreateDate​(java.util.Date value)
      Setter for createDate The CreateDate specific to this jurisdiction.
      void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The date this jurisdiction starts to take effect on tax calculations
      void setEndDate​(java.util.Date value)
      Setter for endDate The date this jurisdiction stops to take effect on tax calculations
      void setId​(java.lang.Integer value)
      Setter for id Unique AvaTax Id of this Jurisdiction
      void setIsAcm​(java.lang.Boolean value)
      Setter for isAcm The isAcm specific to this jurisdiction.
      void setIsLocalAdmin​(java.lang.Boolean value)
      Setter for isLocalAdmin IsLocalAdmin.
      void setIsSst​(java.lang.Boolean value)
      Setter for isSst The isSst specific to this jurisdiction.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate ModifiedDate
      void setName​(java.lang.String value)
      Setter for name The name of this jurisdiction
      void setNexus​(java.util.ArrayList<JurisdictionNexusModel> value)
      Setter for nexus List of Nexus details associated with the jurisdiction
      void setParentId​(java.lang.Integer value)
      Setter for parentId ParentId of the Jurisdiction
      void setPlaceFips​(java.lang.String value)
      Setter for placeFips City FIPS code
      void setRate​(java.math.BigDecimal value)
      Setter for rate The base rate of tax specific to this jurisdiction.
      void setRegion​(java.lang.String value)
      Setter for region Name or ISO 3166 code identifying the region within the country.
      void setSalesRate​(java.math.BigDecimal value)
      Setter for salesRate The "Sales" tax rate specific to this jurisdiction.
      void setShortName​(java.lang.String value)
      Setter for shortName A short name of the jurisidiction
      void setSignatureCode​(java.lang.String value)
      Setter for signatureCode The Avalara-supplied signature code for this jurisdiction.
      void setStateFips​(java.lang.String value)
      Setter for stateFips State FIPS code
      void setTaxAuthorityTypeId​(java.lang.Integer value)
      Setter for taxAuthorityTypeId TaxAuthorityTypeId.
      void setType​(JurisdictionType value)
      Setter for type The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
      void setUseRate​(java.math.BigDecimal value)
      Setter for useRate The "Seller's Use" tax rate specific to this jurisdiction.
      java.lang.String toString()
      Returns a JSON string representation of JurisdictionHierarchyModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JurisdictionHierarchyModel

        public JurisdictionHierarchyModel()
    • Method Detail

      • getParentId

        public java.lang.Integer getParentId()
        Getter for parentId ParentId of the Jurisdiction
      • setParentId

        public void setParentId​(java.lang.Integer value)
        Setter for parentId ParentId of the Jurisdiction
      • getNexus

        public java.util.ArrayList<JurisdictionNexusModel> getNexus()
        Getter for nexus List of Nexus details associated with the jurisdiction
      • setNexus

        public void setNexus​(java.util.ArrayList<JurisdictionNexusModel> value)
        Setter for nexus List of Nexus details associated with the jurisdiction
      • getCode

        public java.lang.String getCode()
        Getter for code The code that is used to identify this jurisdiction
      • setCode

        public void setCode​(java.lang.String value)
        Setter for code The code that is used to identify this jurisdiction
      • getName

        public java.lang.String getName()
        Getter for name The name of this jurisdiction
      • setName

        public void setName​(java.lang.String value)
        Setter for name The name of this jurisdiction
      • getType

        public JurisdictionType getType()
        Getter for type The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
      • setType

        public void setType​(JurisdictionType value)
        Setter for type The type of the jurisdiction, indicating whether it is a country, state/region, city, for example.
      • getRate

        public java.math.BigDecimal getRate()
        Getter for rate The base rate of tax specific to this jurisdiction.
      • setRate

        public void setRate​(java.math.BigDecimal value)
        Setter for rate The base rate of tax specific to this jurisdiction.
      • getSalesRate

        public java.math.BigDecimal getSalesRate()
        Getter for salesRate The "Sales" tax rate specific to this jurisdiction.
      • setSalesRate

        public void setSalesRate​(java.math.BigDecimal value)
        Setter for salesRate The "Sales" tax rate specific to this jurisdiction.
      • getSignatureCode

        public java.lang.String getSignatureCode()
        Getter for signatureCode The Avalara-supplied signature code for this jurisdiction.
      • setSignatureCode

        public void setSignatureCode​(java.lang.String value)
        Setter for signatureCode The Avalara-supplied signature code for this jurisdiction.
      • getRegion

        public java.lang.String getRegion()
        Getter for region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
      • setRegion

        public void setRegion​(java.lang.String value)
        Setter for region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
      • getUseRate

        public java.math.BigDecimal getUseRate()
        Getter for useRate The "Seller's Use" tax rate specific to this jurisdiction.
      • setUseRate

        public void setUseRate​(java.math.BigDecimal value)
        Setter for useRate The "Seller's Use" tax rate specific to this jurisdiction.
      • getCity

        public java.lang.String getCity()
        Getter for city The city name of this jurisdiction
      • setCity

        public void setCity​(java.lang.String value)
        Setter for city The city name of this jurisdiction
      • getCounty

        public java.lang.String getCounty()
        Getter for county The county name of this jurisdiction
      • setCounty

        public void setCounty​(java.lang.String value)
        Setter for county The county name of this jurisdiction
      • getCountry

        public java.lang.String getCountry()
        Getter for country Name or ISO 3166 code identifying the country of this jurisdiction. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
      • setCountry

        public void setCountry​(java.lang.String value)
        Setter for country Name or ISO 3166 code identifying the country of this jurisdiction. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
      • getShortName

        public java.lang.String getShortName()
        Getter for shortName A short name of the jurisidiction
      • setShortName

        public void setShortName​(java.lang.String value)
        Setter for shortName A short name of the jurisidiction
      • getStateFips

        public java.lang.String getStateFips()
        Getter for stateFips State FIPS code
      • setStateFips

        public void setStateFips​(java.lang.String value)
        Setter for stateFips State FIPS code
      • getCountyFips

        public java.lang.String getCountyFips()
        Getter for countyFips County FIPS code
      • setCountyFips

        public void setCountyFips​(java.lang.String value)
        Setter for countyFips County FIPS code
      • getPlaceFips

        public java.lang.String getPlaceFips()
        Getter for placeFips City FIPS code
      • setPlaceFips

        public void setPlaceFips​(java.lang.String value)
        Setter for placeFips City FIPS code
      • getId

        public java.lang.Integer getId()
        Getter for id Unique AvaTax Id of this Jurisdiction
      • setId

        public void setId​(java.lang.Integer value)
        Setter for id Unique AvaTax Id of this Jurisdiction
      • getEffectiveDate

        public java.util.Date getEffectiveDate()
        Getter for effectiveDate The date this jurisdiction starts to take effect on tax calculations
      • setEffectiveDate

        public void setEffectiveDate​(java.util.Date value)
        Setter for effectiveDate The date this jurisdiction starts to take effect on tax calculations
      • getEndDate

        public java.util.Date getEndDate()
        Getter for endDate The date this jurisdiction stops to take effect on tax calculations
      • setEndDate

        public void setEndDate​(java.util.Date value)
        Setter for endDate The date this jurisdiction stops to take effect on tax calculations
      • getIsAcm

        public java.lang.Boolean getIsAcm()
        Getter for isAcm The isAcm specific to this jurisdiction.
      • setIsAcm

        public void setIsAcm​(java.lang.Boolean value)
        Setter for isAcm The isAcm specific to this jurisdiction.
      • getIsSst

        public java.lang.Boolean getIsSst()
        Getter for isSst The isSst specific to this jurisdiction.
      • setIsSst

        public void setIsSst​(java.lang.Boolean value)
        Setter for isSst The isSst specific to this jurisdiction.
      • getCreateDate

        public java.util.Date getCreateDate()
        Getter for createDate The CreateDate specific to this jurisdiction.
      • setCreateDate

        public void setCreateDate​(java.util.Date value)
        Setter for createDate The CreateDate specific to this jurisdiction.
      • getIsLocalAdmin

        public java.lang.Boolean getIsLocalAdmin()
        Getter for isLocalAdmin IsLocalAdmin.
      • setIsLocalAdmin

        public void setIsLocalAdmin​(java.lang.Boolean value)
        Setter for isLocalAdmin IsLocalAdmin.
      • getModifiedDate

        public java.util.Date getModifiedDate()
        Getter for modifiedDate ModifiedDate
      • setModifiedDate

        public void setModifiedDate​(java.util.Date value)
        Setter for modifiedDate ModifiedDate
      • getTaxAuthorityTypeId

        public java.lang.Integer getTaxAuthorityTypeId()
        Getter for taxAuthorityTypeId TaxAuthorityTypeId.
      • setTaxAuthorityTypeId

        public void setTaxAuthorityTypeId​(java.lang.Integer value)
        Setter for taxAuthorityTypeId TaxAuthorityTypeId.
      • toString

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