net.avalara.avatax.rest.client.models

Class LocationModel

java.lang.Object

net.avalara.avatax.rest.client.models.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 and Description
LocationModel()

Method Summary

Modifier and Type	Method and 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 - The two character ISO-3166 country code 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	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.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 - The state, region, or province 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 addressCategoryId) Setter for addressCategoryId - Indicates the type of place of business represented by this location.
void	setAddressTypeId(AddressTypeId addressTypeId) Setter for addressTypeId - Indicates whether this location is a physical place of business or a temporary salesperson location.
void	setCity(java.lang.String city) Setter for city - The city of the physical address of this location.
void	setCompanyId(java.lang.Integer companyId) Setter for companyId - The unique ID number of the company that operates at this location.
void	setCountry(java.lang.String country) Setter for country - The two character ISO-3166 country code of the physical address of this location.
void	setCounty(java.lang.String county) Setter for county - The county name of the physical address of this location.
void	setCreatedDate(java.util.Date createdDate) Setter for createdDate - The date when this record was created.
void	setCreatedUserId(java.lang.Integer createdUserId) Setter for createdUserId - The User ID of the user who created this record.
void	setDbaName(java.lang.String dbaName) 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 description) Setter for description - A friendly name for this location.
void	setEffectiveDate(java.util.Date effectiveDate) Setter for effectiveDate - The date when this location was opened for business, or null if not known.
void	setEndDate(java.util.Date endDate) Setter for endDate - If this place of business has closed, the date when this location closed business.
void	setId(java.lang.Integer id) Setter for id - The unique ID number of this location.
void	setIsDefault(java.lang.Boolean isDefault) Setter for isDefault - Set this flag to true to indicate that this is the default location for this company.
void	setIsRegistered(java.lang.Boolean isRegistered) 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 lastTransactionDate) Setter for lastTransactionDate - The most recent date when a transaction was processed for this location.
void	setLine1(java.lang.String line1) Setter for line1 - The first line of the physical address of this location.
void	setLine2(java.lang.String line2) Setter for line2 - The second line of the physical address of this location.
void	setLine3(java.lang.String line3) Setter for line3 - The third line of the physical address of this location.
void	setLocationCode(java.lang.String locationCode) Setter for locationCode - A code that identifies this location.
void	setModifiedDate(java.util.Date modifiedDate) Setter for modifiedDate - The date/time when this record was last modified.
void	setModifiedUserId(java.lang.Integer modifiedUserId) Setter for modifiedUserId - The user ID of the user who last modified this record.
void	setOutletName(java.lang.String outletName) Setter for outletName - A friendly name for this location.
void	setPostalCode(java.lang.String postalCode) Setter for postalCode - The postal code or zip code of the physical address of this location.
void	setRegion(java.lang.String region) Setter for region - The state, region, or province of the physical address of this location.
void	setRegisteredDate(java.util.Date registeredDate) Setter for registeredDate - The date when this location was registered with a tax authority.
void	setSettings(java.util.ArrayList<LocationSettingModel> settings) 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

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 city)

Setter for city - The city of the physical address of this location.

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 endDate)

Setter for endDate - If this place of business has closed, the date when this location closed business.

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 dbaName)

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.

getDescription

public java.lang.String getDescription()

Getter for description - A friendly name for this location.

setDescription

public void setDescription(java.lang.String description)

Setter for description - A friendly name for this location.

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 modifiedDate)

Setter for modifiedDate - The date/time when this record was last modified.

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 locationCode)

Setter for locationCode - A code that identifies this location. Must be unique within your company.

getCountry

public java.lang.String getCountry()

Getter for country - The two character ISO-3166 country code of the physical address of this location.

setCountry

public void setCountry(java.lang.String country)

Setter for country - The two character ISO-3166 country code of the physical address of 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 addressTypeId)

Setter for addressTypeId - Indicates whether this location is a physical place of business or a temporary salesperson location.

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 line1)

Setter for line1 - The first line of the physical address of this location.

getOutletName

public java.lang.String getOutletName()

Getter for outletName - A friendly name for this location.

setOutletName

public void setOutletName(java.lang.String outletName)

Setter for outletName - A friendly name for this location.

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 postalCode)

Setter for postalCode - The postal code or zip code 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 county)

Setter for county - The county name of the physical address of this location. Not required.

getAddressCategoryId

public AddressCategoryId getAddressCategoryId()

Getter for addressCategoryId - Indicates the type of place of business represented by this location.

setAddressCategoryId

public void setAddressCategoryId(AddressCategoryId addressCategoryId)

Setter for addressCategoryId - Indicates the type of place of business represented by this location.

getId

public java.lang.Integer getId()

Getter for id - The unique ID number of this location.

setId

public void setId(java.lang.Integer id)

Setter for id - The unique ID number of this location.

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 modifiedUserId)

Setter for modifiedUserId - The user ID of the user who last modified this record.

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 effectiveDate)

Setter for effectiveDate - The date when this location was opened for business, or null if not known.

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 createdUserId)

Setter for createdUserId - The User ID of the user who created this record.

getRegion

public java.lang.String getRegion()

Getter for region - The state, region, or province of the physical address of this location.

setRegion

public void setRegion(java.lang.String region)

Setter for region - The state, region, or province 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 line2)

Setter for line2 - The second line of the physical address of this location.

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 isRegistered)

Setter for isRegistered - Set this flag to true to indicate that this location has been registered with a tax authority.

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 registeredDate)

Setter for registeredDate - The date when this location was registered with a tax authority. Not required.

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 lastTransactionDate)

Setter for lastTransactionDate - The most recent date when a transaction was processed for this location. Set by AvaTax.

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> settings)

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".

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 isDefault)

Setter for isDefault - Set this flag to true to indicate that this is the default location for this company.

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 companyId)

Setter for companyId - The unique ID number of the company that operates at this location.

getCreatedDate

public java.util.Date getCreatedDate()

Getter for createdDate - The date when this record was created.

setCreatedDate

public void setCreatedDate(java.util.Date createdDate)

Setter for createdDate - The date when this record was created.

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 line3)

Setter for line3 - The third line of the physical address of this location.

toString

public java.lang.String toString()

Returns a JSON string representation of LocationModel.

Overrides:

toString in class java.lang.Object