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

Class LocationModel

java.lang.Object
net.avalara.avatax.rest.client.models.LocationModel
public class LocationModel extends 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

    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.
    String
    getCity()
    Getter for city The city of the physical address of this location.
    Integer
    getCompanyId()
    Getter for companyId The unique ID number of the company that operates at this location.
    String
    getCountry()
    Getter for country Name or ISO 3166 code identifying the country of the physical address of this location.
    String
    getCounty()
    Getter for county The county name of the physical address of this location.
    Date
    getCreatedDate()
    Getter for createdDate The date when this record was created.
    Integer
    getCreatedUserId()
    Getter for createdUserId The User ID of the user who created this record.
    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.
    String
    getDescription()
    Getter for description A friendly name for this location.
    Date
    getEffectiveDate()
    Getter for effectiveDate The date when this location was opened for business, or null if not known.
    Date
    getEndDate()
    Getter for endDate If this place of business has closed, the date when this location closed business.
    Integer
    getId()
    Getter for id The unique ID number of this location.
    Boolean
    getIsDefault()
    Getter for isDefault Set this flag to true to indicate that this is the default location for this company.
    Boolean
    getIsMarketplaceOutsideUsa()
    Getter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
    Boolean
    getIsRegistered()
    Getter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
    Date
    getLastTransactionDate()
    Getter for lastTransactionDate The most recent date when a transaction was processed for this location.
    String
    getLine1()
    Getter for line1 The first line of the physical address of this location.
    String
    getLine2()
    Getter for line2 The second line of the physical address of this location.
    String
    getLine3()
    Getter for line3 The third line of the physical address of this location.
    String
    getLocationCode()
    Getter for locationCode A code that identifies this location.
    Date
    getModifiedDate()
    Getter for modifiedDate The date/time when this record was last modified.
    Integer
    getModifiedUserId()
    Getter for modifiedUserId The user ID of the user who last modified this record.
    String
    getOutletName()
    Getter for outletName A friendly name for this location.
    ArrayList<LocationParameterModel>
    getParameters()
    Getter for parameters List of location parameters.
    String
    getPostalCode()
    Getter for postalCode The postal code or zip code of the physical address of this location.
    String
    getRegion()
    Getter for region Name or ISO 3166 code identifying the region within the country of the physical address of this location.
    Date
    getRegisteredDate()
    Getter for registeredDate The date when this location was registered with a tax authority.
    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(String value)
    Setter for city The city of the physical address of this location.
    void
    setCompanyId(Integer value)
    Setter for companyId The unique ID number of the company that operates at this location.
    void
    setCountry(String value)
    Setter for country Name or ISO 3166 code identifying the country of the physical address of this location.
    void
    setCounty(String value)
    Setter for county The county name of the physical address of this location.
    void
    setCreatedDate(Date value)
    Setter for createdDate The date when this record was created.
    void
    setCreatedUserId(Integer value)
    Setter for createdUserId The User ID of the user who created this record.
    void
    setDbaName(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(String value)
    Setter for description A friendly name for this location.
    void
    setEffectiveDate(Date value)
    Setter for effectiveDate The date when this location was opened for business, or null if not known.
    void
    setEndDate(Date value)
    Setter for endDate If this place of business has closed, the date when this location closed business.
    void
    setId(Integer value)
    Setter for id The unique ID number of this location.
    void
    setIsDefault(Boolean value)
    Setter for isDefault Set this flag to true to indicate that this is the default location for this company.
    void
    setIsMarketplaceOutsideUsa(Boolean value)
    Setter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA
    void
    setIsRegistered(Boolean value)
    Setter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.
    void
    setLastTransactionDate(Date value)
    Setter for lastTransactionDate The most recent date when a transaction was processed for this location.
    void
    setLine1(String value)
    Setter for line1 The first line of the physical address of this location.
    void
    setLine2(String value)
    Setter for line2 The second line of the physical address of this location.
    void
    setLine3(String value)
    Setter for line3 The third line of the physical address of this location.
    void
    setLocationCode(String value)
    Setter for locationCode A code that identifies this location.
    void
    setModifiedDate(Date value)
    Setter for modifiedDate The date/time when this record was last modified.
    void
    setModifiedUserId(Integer value)
    Setter for modifiedUserId The user ID of the user who last modified this record.
    void
    setOutletName(String value)
    Setter for outletName A friendly name for this location.
    void
    setParameters(ArrayList<LocationParameterModel> value)
    Setter for parameters List of location parameters.
    void
    setPostalCode(String value)
    Setter for postalCode The postal code or zip code of the physical address of this location.
    void
    setRegion(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(Date value)
    Setter for registeredDate The date when this location was registered with a tax authority.
    void
    setSettings(ArrayList<LocationSettingModel> value)
    Setter for settings Extra information required by certain jurisdictions for filing.
    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 Details

    • LocationModel

      public LocationModel()

  • Method Details

    • getId

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

    • setId

      public void setId(Integer value)
      Setter for id The unique ID number of this location.

    • getCompanyId

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

    • setCompanyId

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

    • getLocationCode

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

    • setLocationCode

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

    • getDescription

      public String getDescription()
      Getter for description A friendly name for this location.

    • setDescription

      public void setDescription(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 Boolean getIsMarketplaceOutsideUsa()
      Getter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA

    • setIsMarketplaceOutsideUsa

      public void setIsMarketplaceOutsideUsa(Boolean value)
      Setter for isMarketplaceOutsideUsa Indicates whether the Marketplace is outside or in USA

    • getLine1

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

    • setLine1

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

    • getLine2

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

    • setLine2

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

    • getLine3

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

    • setLine3

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

    • getCity

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

    • setCity

      public void setCity(String value)
      Setter for city The city of the physical address of this location.

    • getCounty

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

    • setCounty

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

    • getRegion

      public 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(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 String getPostalCode()
      Getter for postalCode The postal code or zip code of the physical address of this location.

    • setPostalCode

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

    • getCountry

      public 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(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 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(Boolean value)
      Setter for isDefault Set this flag to true to indicate that this is the default location for this company.

    • getIsRegistered

      public 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(Boolean value)
      Setter for isRegistered Set this flag to true to indicate that this location has been registered with a tax authority.

    • getDbaName

      public 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(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 String getOutletName()
      Getter for outletName A friendly name for this location.

    • setOutletName

      public void setOutletName(String value)
      Setter for outletName A friendly name for this location.

    • getEffectiveDate

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

    • setEffectiveDate

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

    • getEndDate

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

    • setEndDate

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

    • getLastTransactionDate

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

    • setLastTransactionDate

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

    • getRegisteredDate

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

    • setRegisteredDate

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

    • getCreatedDate

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

    • setCreatedDate

      public void setCreatedDate(Date value)
      Setter for createdDate The date when this record was created.

    • getCreatedUserId

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

    • setCreatedUserId

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

    • getModifiedDate

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

    • setModifiedDate

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

    • getModifiedUserId

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

    • setModifiedUserId

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

    • getSettings

      public 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(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 ArrayList<LocationParameterModel> getParameters()
      Getter for parameters List of location parameters.

    • setParameters

      public void setParameters(ArrayList<LocationParameterModel> value)
      Setter for parameters List of location parameters.

    • toString

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