Class CompanyModel
java.lang.Object
net.avalara.avatax.rest.client.models.CompanyModel
public class CompanyModel
extends java.lang.Object
A company or business entity.
-
Constructor Summary
Constructors Constructor Description CompanyModel()
-
Method Summary
Modifier and Type Method Description java.lang.Integer
getAccountId()
Getter for accountId The unique ID number of the account this company belongs to.java.lang.String
getBaseCurrencyCode()
Getter for baseCurrencyCode This is the three character ISO-4217 currency code of the default currency used by this company.java.lang.String
getBusinessIdentificationNo()
Getter for businessIdentificationNo Business Identification Nojava.lang.String
getCompanyCode()
Getter for companyCode A unique code that references this company within your account.java.util.ArrayList<ContactModel>
getContacts()
Getter for contacts Optional: A list of contacts defined for this company.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
getDefaultCountry()
Getter for defaultCountry The two character ISO-3166 country code of the default country for this company.java.lang.Integer
getDefaultLocationId()
Getter for defaultLocationId If set, this is the unique ID number of the default location for this company.java.util.ArrayList<EcmsModel>
getExemptCerts()
Getter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API.java.lang.Boolean
getHasProfile()
Getter for hasProfile Set this flag to true to give this company its own unique tax profile.java.lang.Integer
getId()
Getter for id The unique ID number of this company.java.lang.Boolean
getInProgress()
Getter for inProgress Set this value to true to indicate that you are still working to finish configuring this company.java.lang.Boolean
getIsActive()
Getter for isActive This flag indicates whether tax activity can occur for this company.java.lang.Boolean
getIsDefault()
Getter for isDefault This flag is true if this company is the default company for this account.java.lang.Boolean
getIsFein()
Getter for isFein Set this field to true if the taxPayerIdNumber is a FEIN.java.lang.Boolean
getIsReportingEntity()
Getter for isReportingEntity Set this flag to true if this company must file its own tax returns.java.lang.Boolean
getIsTest()
Getter for isTest Set this flag to true to indicate that this company is a test company.java.util.ArrayList<ItemModel>
getItems()
Getter for items Optional: A list of items defined for this company.java.util.ArrayList<LocationModel>
getLocations()
Getter for locations Optional: A list of locations defined for this company.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
getMossCountry()
Getter for mossCountry The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.java.lang.String
getMossId()
Getter for mossId The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.java.lang.String
getName()
Getter for name The name of this company, as shown to customers.java.util.ArrayList<NexusModel>
getNexus()
Getter for nexus Optional: A list of nexus defined for this company.java.util.ArrayList<CompanyModel>
getNonReportingChildCompanies()
Getter for nonReportingChildCompanies Optional: A list of non reporting child companies associated with this company.java.util.ArrayList<CompanyParameterDetailModel>
getParameters()
Getter for parameters The parameters of a companyjava.lang.Integer
getParentCompanyId()
Getter for parentCompanyId If this company is fully owned by another company, this is the unique identity of the parent company.RoundingLevelId
getRoundingLevelId()
Getter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level.java.util.ArrayList<SettingModel>
getSettings()
Getter for settings Optional: A list of settings defined for this company.java.util.Date
getSstEffectiveDate()
Getter for sstEffectiveDate If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.java.lang.String
getSstPid()
Getter for sstPid If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board.java.util.ArrayList<CustomerSupplierModel>
getSupplierandcustomers()
Getter for supplierandcustomers The customers and suppliers of a companyjava.util.ArrayList<TaxCodeModel>
getTaxCodes()
Getter for taxCodes Optional: A list of tax codes defined for this company.TaxDependencyLevelId
getTaxDependencyLevelId()
Getter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level.java.lang.String
getTaxpayerIdNumber()
Getter for taxpayerIdNumber For United States companies, this field contains your Taxpayer Identification Number.java.util.ArrayList<TaxRuleModel>
getTaxRules()
Getter for taxRules Optional: A list of tax rules defined for this company.java.util.ArrayList<UPCModel>
getUpcs()
Getter for upcs Optional: A list of UPCs defined for this company.java.lang.Boolean
getWarningsEnabled()
Getter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP.void
setAccountId(java.lang.Integer value)
Setter for accountId The unique ID number of the account this company belongs to.void
setBaseCurrencyCode(java.lang.String value)
Setter for baseCurrencyCode This is the three character ISO-4217 currency code of the default currency used by this company.void
setBusinessIdentificationNo(java.lang.String value)
Setter for businessIdentificationNo Business Identification Novoid
setCompanyCode(java.lang.String value)
Setter for companyCode A unique code that references this company within your account.void
setContacts(java.util.ArrayList<ContactModel> value)
Setter for contacts Optional: A list of contacts defined for this company.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
setDefaultCountry(java.lang.String value)
Setter for defaultCountry The two character ISO-3166 country code of the default country for this company.void
setDefaultLocationId(java.lang.Integer value)
Setter for defaultLocationId If set, this is the unique ID number of the default location for this company.void
setExemptCerts(java.util.ArrayList<EcmsModel> value)
Setter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API.void
setHasProfile(java.lang.Boolean value)
Setter for hasProfile Set this flag to true to give this company its own unique tax profile.void
setId(java.lang.Integer value)
Setter for id The unique ID number of this company.void
setInProgress(java.lang.Boolean value)
Setter for inProgress Set this value to true to indicate that you are still working to finish configuring this company.void
setIsActive(java.lang.Boolean value)
Setter for isActive This flag indicates whether tax activity can occur for this company.void
setIsDefault(java.lang.Boolean value)
Setter for isDefault This flag is true if this company is the default company for this account.void
setIsFein(java.lang.Boolean value)
Setter for isFein Set this field to true if the taxPayerIdNumber is a FEIN.void
setIsReportingEntity(java.lang.Boolean value)
Setter for isReportingEntity Set this flag to true if this company must file its own tax returns.void
setIsTest(java.lang.Boolean value)
Setter for isTest Set this flag to true to indicate that this company is a test company.void
setItems(java.util.ArrayList<ItemModel> value)
Setter for items Optional: A list of items defined for this company.void
setLocations(java.util.ArrayList<LocationModel> value)
Setter for locations Optional: A list of locations defined for this company.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
setMossCountry(java.lang.String value)
Setter for mossCountry The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.void
setMossId(java.lang.String value)
Setter for mossId The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.void
setName(java.lang.String value)
Setter for name The name of this company, as shown to customers.void
setNexus(java.util.ArrayList<NexusModel> value)
Setter for nexus Optional: A list of nexus defined for this company.void
setNonReportingChildCompanies(java.util.ArrayList<CompanyModel> value)
Setter for nonReportingChildCompanies Optional: A list of non reporting child companies associated with this company.void
setParameters(java.util.ArrayList<CompanyParameterDetailModel> value)
Setter for parameters The parameters of a companyvoid
setParentCompanyId(java.lang.Integer value)
Setter for parentCompanyId If this company is fully owned by another company, this is the unique identity of the parent company.void
setRoundingLevelId(RoundingLevelId value)
Setter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level.void
setSettings(java.util.ArrayList<SettingModel> value)
Setter for settings Optional: A list of settings defined for this company.void
setSstEffectiveDate(java.util.Date value)
Setter for sstEffectiveDate If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.void
setSstPid(java.lang.String value)
Setter for sstPid If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board.void
setSupplierandcustomers(java.util.ArrayList<CustomerSupplierModel> value)
Setter for supplierandcustomers The customers and suppliers of a companyvoid
setTaxCodes(java.util.ArrayList<TaxCodeModel> value)
Setter for taxCodes Optional: A list of tax codes defined for this company.void
setTaxDependencyLevelId(TaxDependencyLevelId value)
Setter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level.void
setTaxpayerIdNumber(java.lang.String value)
Setter for taxpayerIdNumber For United States companies, this field contains your Taxpayer Identification Number.void
setTaxRules(java.util.ArrayList<TaxRuleModel> value)
Setter for taxRules Optional: A list of tax rules defined for this company.void
setUpcs(java.util.ArrayList<UPCModel> value)
Setter for upcs Optional: A list of UPCs defined for this company.void
setWarningsEnabled(java.lang.Boolean value)
Setter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP.java.lang.String
toString()
Returns a JSON string representation of CompanyModel
-
Constructor Details
-
CompanyModel
public CompanyModel()
-
-
Method Details
-
getId
public java.lang.Integer getId()Getter for id The unique ID number of this company. -
setId
public void setId(java.lang.Integer value)Setter for id The unique ID number of this company. -
getAccountId
public java.lang.Integer getAccountId()Getter for accountId The unique ID number of the account this company belongs to. -
setAccountId
public void setAccountId(java.lang.Integer value)Setter for accountId The unique ID number of the account this company belongs to. -
getParentCompanyId
public java.lang.Integer getParentCompanyId()Getter for parentCompanyId If this company is fully owned by another company, this is the unique identity of the parent company. -
setParentCompanyId
public void setParentCompanyId(java.lang.Integer value)Setter for parentCompanyId If this company is fully owned by another company, this is the unique identity of the parent company. -
getSstPid
public java.lang.String getSstPid()Getter for sstPid If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board. -
setSstPid
public void setSstPid(java.lang.String value)Setter for sstPid If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board. -
getCompanyCode
public java.lang.String getCompanyCode()Getter for companyCode A unique code that references this company within your account. -
setCompanyCode
public void setCompanyCode(java.lang.String value)Setter for companyCode A unique code that references this company within your account. -
getName
public java.lang.String getName()Getter for name The name of this company, as shown to customers. -
setName
public void setName(java.lang.String value)Setter for name The name of this company, as shown to customers. -
getIsDefault
public java.lang.Boolean getIsDefault()Getter for isDefault This flag is true if this company is the default company for this account. Only one company may be set as the default. -
setIsDefault
public void setIsDefault(java.lang.Boolean value)Setter for isDefault This flag is true if this company is the default company for this account. Only one company may be set as the default. -
getDefaultLocationId
public java.lang.Integer getDefaultLocationId()Getter for defaultLocationId If set, this is the unique ID number of the default location for this company. -
setDefaultLocationId
public void setDefaultLocationId(java.lang.Integer value)Setter for defaultLocationId If set, this is the unique ID number of the default location for this company. -
getIsActive
public java.lang.Boolean getIsActive()Getter for isActive This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions. -
setIsActive
public void setIsActive(java.lang.Boolean value)Setter for isActive This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions. -
getTaxpayerIdNumber
public java.lang.String getTaxpayerIdNumber()Getter for taxpayerIdNumber For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional. -
setTaxpayerIdNumber
public void setTaxpayerIdNumber(java.lang.String value)Setter for taxpayerIdNumber For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional. -
getIsFein
public java.lang.Boolean getIsFein()Getter for isFein Set this field to true if the taxPayerIdNumber is a FEIN. -
setIsFein
public void setIsFein(java.lang.Boolean value)Setter for isFein Set this field to true if the taxPayerIdNumber is a FEIN. -
getHasProfile
public java.lang.Boolean getHasProfile()Getter for hasProfile Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent. -
setHasProfile
public void setHasProfile(java.lang.Boolean value)Setter for hasProfile Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent. -
getIsReportingEntity
public java.lang.Boolean getIsReportingEntity()Getter for isReportingEntity Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company. -
setIsReportingEntity
public void setIsReportingEntity(java.lang.Boolean value)Setter for isReportingEntity Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company. -
getSstEffectiveDate
public java.util.Date getSstEffectiveDate()Getter for sstEffectiveDate If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program. -
setSstEffectiveDate
public void setSstEffectiveDate(java.util.Date value)Setter for sstEffectiveDate If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program. -
getDefaultCountry
public java.lang.String getDefaultCountry()Getter for defaultCountry The two character ISO-3166 country code of the default country for this company. -
setDefaultCountry
public void setDefaultCountry(java.lang.String value)Setter for defaultCountry The two character ISO-3166 country code of the default country for this company. -
getBaseCurrencyCode
public java.lang.String getBaseCurrencyCode()Getter for baseCurrencyCode This is the three character ISO-4217 currency code of the default currency used by this company. -
setBaseCurrencyCode
public void setBaseCurrencyCode(java.lang.String value)Setter for baseCurrencyCode This is the three character ISO-4217 currency code of the default currency used by this company. -
getRoundingLevelId
Getter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level. -
setRoundingLevelId
Setter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level. -
getWarningsEnabled
public java.lang.Boolean getWarningsEnabled()Getter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP. -
setWarningsEnabled
public void setWarningsEnabled(java.lang.Boolean value)Setter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP. -
getIsTest
public java.lang.Boolean getIsTest()Getter for isTest Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes. -
setIsTest
public void setIsTest(java.lang.Boolean value)Setter for isTest Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes. -
getTaxDependencyLevelId
Getter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level. -
setTaxDependencyLevelId
Setter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level. -
getInProgress
public java.lang.Boolean getInProgress()Getter for inProgress Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions. -
setInProgress
public void setInProgress(java.lang.Boolean value)Setter for inProgress Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions. -
getBusinessIdentificationNo
public java.lang.String getBusinessIdentificationNo()Getter for businessIdentificationNo Business Identification No -
setBusinessIdentificationNo
public void setBusinessIdentificationNo(java.lang.String value)Setter for businessIdentificationNo Business Identification No -
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. -
getContacts
Getter for contacts Optional: A list of contacts defined for this company. To fetch this list, add the query string `?$include=Contacts` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setContacts
Setter for contacts Optional: A list of contacts defined for this company. To fetch this list, add the query string `?$include=Contacts` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getItems
Getter for items Optional: A list of items defined for this company. To fetch this list, add the query string `?$include=Items` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setItems
Setter for items Optional: A list of items defined for this company. To fetch this list, add the query string `?$include=Items` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getLocations
Getter for locations Optional: A list of locations defined for this company. To fetch this list, add the query string `?$include=Locations` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setLocations
Setter for locations Optional: A list of locations defined for this company. To fetch this list, add the query string `?$include=Locations` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getNexus
Getter for nexus Optional: A list of nexus defined for this company. To fetch this list, add the query string `?$include=Nexus` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setNexus
Setter for nexus Optional: A list of nexus defined for this company. To fetch this list, add the query string `?$include=Nexus` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getSettings
Getter for settings Optional: A list of settings defined for this company. To fetch this list, add the query string `?$include=Settings` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setSettings
Setter for settings Optional: A list of settings defined for this company. To fetch this list, add the query string `?$include=Settings` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getTaxCodes
Getter for taxCodes Optional: A list of tax codes defined for this company. To fetch this list, add the query string `?$include=TaxCodes` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setTaxCodes
Setter for taxCodes Optional: A list of tax codes defined for this company. To fetch this list, add the query string `?$include=TaxCodes` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getTaxRules
Getter for taxRules Optional: A list of tax rules defined for this company. To fetch this list, add the query string `?$include=TaxRules` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setTaxRules
Setter for taxRules Optional: A list of tax rules defined for this company. To fetch this list, add the query string `?$include=TaxRules` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getUpcs
Getter for upcs Optional: A list of UPCs defined for this company. To fetch this list, add the query string `?$include=UPCs` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
setUpcs
Setter for upcs Optional: A list of UPCs defined for this company. To fetch this list, add the query string `?$include=UPCs` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. -
getNonReportingChildCompanies
Getter for nonReportingChildCompanies Optional: A list of non reporting child companies associated with this company. To fetch this list, add the query string `?$include=NonReportingChildren` to your URL. -
setNonReportingChildCompanies
Setter for nonReportingChildCompanies Optional: A list of non reporting child companies associated with this company. To fetch this list, add the query string `?$include=NonReportingChildren` to your URL. -
getExemptCerts
Getter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API. -
setExemptCerts
Setter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API. -
getMossId
public java.lang.String getMossId()Getter for mossId The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing. -
setMossId
public void setMossId(java.lang.String value)Setter for mossId The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing. -
getMossCountry
public java.lang.String getMossCountry()Getter for mossCountry The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing. -
setMossCountry
public void setMossCountry(java.lang.String value)Setter for mossCountry The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing. -
getParameters
Getter for parameters The parameters of a company -
setParameters
Setter for parameters The parameters of a company -
getSupplierandcustomers
Getter for supplierandcustomers The customers and suppliers of a company -
setSupplierandcustomers
Setter for supplierandcustomers The customers and suppliers of a company -
toString
public java.lang.String toString()Returns a JSON string representation of CompanyModel- Overrides:
toString
in classjava.lang.Object
-