Class LocationModel


  • public class LocationModel
    extends java.lang.Object
    A location where this company does business. Some jurisdictions may require you to list all locations where your company does business.
    • Constructor Summary

      Constructors 
      Constructor Description
      LocationModel()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AddressCategoryId getAddressCategoryId()
      Getter for addressCategoryId Indicates the type of place of business represented by this location.
      AddressTypeId getAddressTypeId()
      Getter for addressTypeId Indicates whether this location is a physical place of business or a temporary salesperson location.
      java.lang.String getCity()
      Getter for city The city of the physical address of this location.
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the company that operates at this location.
      java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country of the physical address of this location.
      java.lang.String getCounty()
      Getter for county The county name of the physical address of this location.
      java.util.Date getCreatedDate()
      Getter for createdDate The date when this record was created.
      java.lang.Integer getCreatedUserId()
      Getter for createdUserId The User ID of the user who created this record.
      java.lang.String getDbaName()
      Getter for dbaName If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
      java.lang.String getDescription()
      Getter for description A friendly name for this location.
      java.util.Date getEffectiveDate()
      Getter for effectiveDate The date when this location was opened for business, or null if not known.
      java.util.Date getEndDate()
      Getter for endDate If this place of business has closed, the date when this location closed business.
      java.lang.Integer getId()
      Getter for id The unique ID number of this location.
      java.lang.Boolean getIsDefault()
      Getter for isDefault Set this flag to true to indicate that this is the default location for this company.
      java.lang.Boolean getIsMarketplaceOutsideUsa()
      Getter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
      java.lang.Boolean getIsRegistered()
      Getter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
      java.util.Date getLastTransactionDate()
      Getter for lastTransactionDate The most recent date when a transaction was processed for this location.
      java.lang.String getLine1()
      Getter for line1 The first line of the physical address of this location.
      java.lang.String getLine2()
      Getter for line2 The second line of the physical address of this location.
      java.lang.String getLine3()
      Getter for line3 The third line of the physical address of this location.
      java.lang.String getLocationCode()
      Getter for locationCode A code that identifies this location.
      java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.
      java.lang.Integer getModifiedUserId()
      Getter for modifiedUserId The user ID of the user who last modified this record.
      java.lang.String getOutletName()
      Getter for outletName A friendly name for this location.
      java.util.ArrayList<LocationParameterModel> getParameters()
      Getter for parameters List of location parameters.
      java.lang.String getPostalCode()
      Getter for postalCode The postal code or zip code of the physical address of this location.
      java.lang.String getRegion()
      Getter for region Name or ISO 3166 code identifying the region within the country of the physical address of this location.
      java.util.Date getRegisteredDate()
      Getter for registeredDate The date when this location was registered with a tax authority.
      java.util.ArrayList<LocationSettingModel> getSettings()
      Getter for settings Extra information required by certain jurisdictions for filing.
      void setAddressCategoryId​(AddressCategoryId value)
      Setter for addressCategoryId Indicates the type of place of business represented by this location.
      void setAddressTypeId​(AddressTypeId value)
      Setter for addressTypeId Indicates whether this location is a physical place of business or a temporary salesperson location.
      void setCity​(java.lang.String value)
      Setter for city The city of the physical address of this location.
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the company that operates at this location.
      void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country of the physical address of this location.
      void setCounty​(java.lang.String value)
      Setter for county The county name of the physical address of this location.
      void setCreatedDate​(java.util.Date value)
      Setter for createdDate The date when this record was created.
      void setCreatedUserId​(java.lang.Integer value)
      Setter for createdUserId The User ID of the user who created this record.
      void setDbaName​(java.lang.String value)
      Setter for dbaName If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
      void setDescription​(java.lang.String value)
      Setter for description A friendly name for this location.
      void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The date when this location was opened for business, or null if not known.
      void setEndDate​(java.util.Date value)
      Setter for endDate If this place of business has closed, the date when this location closed business.
      void setId​(java.lang.Integer value)
      Setter for id The unique ID number of this location.
      void setIsDefault​(java.lang.Boolean value)
      Setter for isDefault Set this flag to true to indicate that this is the default location for this company.
      void setIsMarketplaceOutsideUsa​(java.lang.Boolean value)
      Setter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
      void setIsRegistered​(java.lang.Boolean value)
      Setter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
      void setLastTransactionDate​(java.util.Date value)
      Setter for lastTransactionDate The most recent date when a transaction was processed for this location.
      void setLine1​(java.lang.String value)
      Setter for line1 The first line of the physical address of this location.
      void setLine2​(java.lang.String value)
      Setter for line2 The second line of the physical address of this location.
      void setLine3​(java.lang.String value)
      Setter for line3 The third line of the physical address of this location.
      void setLocationCode​(java.lang.String value)
      Setter for locationCode A code that identifies this location.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.
      void setModifiedUserId​(java.lang.Integer value)
      Setter for modifiedUserId The user ID of the user who last modified this record.
      void setOutletName​(java.lang.String value)
      Setter for outletName A friendly name for this location.
      void setParameters​(java.util.ArrayList<LocationParameterModel> value)
      Setter for parameters List of location parameters.
      void setPostalCode​(java.lang.String value)
      Setter for postalCode The postal code or zip code of the physical address of this location.
      void setRegion​(java.lang.String value)
      Setter for region Name or ISO 3166 code identifying the region within the country of the physical address of this location.
      void setRegisteredDate​(java.util.Date value)
      Setter for registeredDate The date when this location was registered with a tax authority.
      void setSettings​(java.util.ArrayList<LocationSettingModel> value)
      Setter for settings Extra information required by certain jurisdictions for filing.
      java.lang.String toString()
      Returns a JSON string representation of LocationModel
      • Methods inherited from class java.lang.Object

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

      • LocationModel

        public LocationModel()
    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id The unique ID number of this location.
      • setId

        public void setId​(java.lang.Integer value)
        Setter for id The unique ID number of this location.
      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId The unique ID number of the company that operates at this location.
      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId The unique ID number of the company that operates at this location.
      • getLocationCode

        public java.lang.String getLocationCode()
        Getter for locationCode A code that identifies this location. Must be unique within your company.
      • setLocationCode

        public void setLocationCode​(java.lang.String value)
        Setter for locationCode A code that identifies this location. Must be unique within your company.
      • getDescription

        public java.lang.String getDescription()
        Getter for description A friendly name for this location.
      • setDescription

        public void setDescription​(java.lang.String value)
        Setter for description A friendly name for this location.
      • getAddressTypeId

        public AddressTypeId getAddressTypeId()
        Getter for addressTypeId Indicates whether this location is a physical place of business or a temporary salesperson location.
      • setAddressTypeId

        public void setAddressTypeId​(AddressTypeId value)
        Setter for addressTypeId Indicates whether this location is a physical place of business or a temporary salesperson location.
      • getAddressCategoryId

        public AddressCategoryId getAddressCategoryId()
        Getter for addressCategoryId Indicates the type of place of business represented by this location.
      • setAddressCategoryId

        public void setAddressCategoryId​(AddressCategoryId value)
        Setter for addressCategoryId Indicates the type of place of business represented by this location.
      • getIsMarketplaceOutsideUsa

        public java.lang.Boolean getIsMarketplaceOutsideUsa()
        Getter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
      • setIsMarketplaceOutsideUsa

        public void setIsMarketplaceOutsideUsa​(java.lang.Boolean value)
        Setter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
      • getLine1

        public java.lang.String getLine1()
        Getter for line1 The first line of the physical address of this location.
      • setLine1

        public void setLine1​(java.lang.String value)
        Setter for line1 The first line of the physical address of this location.
      • getLine2

        public java.lang.String getLine2()
        Getter for line2 The second line of the physical address of this location.
      • setLine2

        public void setLine2​(java.lang.String value)
        Setter for line2 The second line of the physical address of this location.
      • getLine3

        public java.lang.String getLine3()
        Getter for line3 The third line of the physical address of this location.
      • setLine3

        public void setLine3​(java.lang.String value)
        Setter for line3 The third line of the physical address of this location.
      • getCity

        public java.lang.String getCity()
        Getter for city The city of the physical address of this location.
      • setCity

        public void setCity​(java.lang.String value)
        Setter for city The city of the physical address of this location.
      • getCounty

        public java.lang.String getCounty()
        Getter for county The county name of the physical address of this location. Not required.
      • setCounty

        public void setCounty​(java.lang.String value)
        Setter for county The county name of the physical address of this location. Not required.
      • getRegion

        public java.lang.String getRegion()
        Getter for region Name or ISO 3166 code identifying the region within the country of the physical address of this location. 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 of the physical address of this location. 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`.
      • getPostalCode

        public java.lang.String getPostalCode()
        Getter for postalCode The postal code or zip code of the physical address of this location.
      • setPostalCode

        public void setPostalCode​(java.lang.String value)
        Setter for postalCode The postal code or zip code of the physical address of this location.
      • getCountry

        public java.lang.String getCountry()
        Getter for country Name or ISO 3166 code identifying the country of the physical address of this location. 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 the physical address of this location. 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`.
      • getIsDefault

        public java.lang.Boolean getIsDefault()
        Getter for isDefault Set this flag to true to indicate that this is the default location for this company.
      • setIsDefault

        public void setIsDefault​(java.lang.Boolean value)
        Setter for isDefault Set this flag to true to indicate that this is the default location for this company.
      • getIsRegistered

        public java.lang.Boolean getIsRegistered()
        Getter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
      • setIsRegistered

        public void setIsRegistered​(java.lang.Boolean value)
        Setter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
      • getDbaName

        public java.lang.String getDbaName()
        Getter for dbaName If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
      • setDbaName

        public void setDbaName​(java.lang.String value)
        Setter for dbaName If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location.
      • getOutletName

        public java.lang.String getOutletName()
        Getter for outletName A friendly name for this location.
      • setOutletName

        public void setOutletName​(java.lang.String value)
        Setter for outletName A friendly name for this location.
      • getEffectiveDate

        public java.util.Date getEffectiveDate()
        Getter for effectiveDate The date when this location was opened for business, or null if not known.
      • setEffectiveDate

        public void setEffectiveDate​(java.util.Date value)
        Setter for effectiveDate The date when this location was opened for business, or null if not known.
      • getEndDate

        public java.util.Date getEndDate()
        Getter for endDate If this place of business has closed, the date when this location closed business.
      • setEndDate

        public void setEndDate​(java.util.Date value)
        Setter for endDate If this place of business has closed, the date when this location closed business.
      • getLastTransactionDate

        public java.util.Date getLastTransactionDate()
        Getter for lastTransactionDate The most recent date when a transaction was processed for this location. Set by AvaTax.
      • setLastTransactionDate

        public void setLastTransactionDate​(java.util.Date value)
        Setter for lastTransactionDate The most recent date when a transaction was processed for this location. Set by AvaTax.
      • getRegisteredDate

        public java.util.Date getRegisteredDate()
        Getter for registeredDate The date when this location was registered with a tax authority. Not required.
      • setRegisteredDate

        public void setRegisteredDate​(java.util.Date value)
        Setter for registeredDate The date when this location was registered with a tax authority. Not required.
      • getCreatedDate

        public java.util.Date getCreatedDate()
        Getter for createdDate The date when this record was created.
      • setCreatedDate

        public void setCreatedDate​(java.util.Date value)
        Setter for createdDate The date when this record was created.
      • getCreatedUserId

        public java.lang.Integer getCreatedUserId()
        Getter for createdUserId The User ID of the user who created this record.
      • setCreatedUserId

        public void setCreatedUserId​(java.lang.Integer value)
        Setter for createdUserId The User ID of the user who created this record.
      • getModifiedDate

        public java.util.Date getModifiedDate()
        Getter for modifiedDate The date/time when this record was last modified.
      • setModifiedDate

        public void setModifiedDate​(java.util.Date value)
        Setter for modifiedDate The date/time when this record was last modified.
      • getModifiedUserId

        public java.lang.Integer getModifiedUserId()
        Getter for modifiedUserId The user ID of the user who last modified this record.
      • setModifiedUserId

        public void setModifiedUserId​(java.lang.Integer value)
        Setter for modifiedUserId The user ID of the user who last modified this record.
      • getSettings

        public java.util.ArrayList<LocationSettingModel> getSettings()
        Getter for settings Extra information required by certain jurisdictions for filing. For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions". To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate".
      • setSettings

        public void setSettings​(java.util.ArrayList<LocationSettingModel> value)
        Setter for settings Extra information required by certain jurisdictions for filing. For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions". To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate".
      • getParameters

        public java.util.ArrayList<LocationParameterModel> getParameters()
        Getter for parameters List of location parameters.
      • setParameters

        public void setParameters​(java.util.ArrayList<LocationParameterModel> value)
        Setter for parameters List of location parameters.
      • toString

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