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

Class CompanyModel

java.lang.Object
net.avalara.avatax.rest.client.models.CompanyModel
public class CompanyModel extends Object
A company or business entity.

  • Constructor Details

    • CompanyModel

      public CompanyModel()

  • Method Details

    • getId

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

    • setId

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

    • getAccountId

      public Integer getAccountId()
      Getter for accountId The unique ID number of the account this company belongs to.

    • setAccountId

      public void setAccountId(Integer value)
      Setter for accountId The unique ID number of the account this company belongs to.

    • getParentCompanyId

      public 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(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 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(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 String getCompanyCode()
      Getter for companyCode A unique code that references this company within your account.

    • setCompanyCode

      public void setCompanyCode(String value)
      Setter for companyCode A unique code that references this company within your account.

    • getName

      public String getName()
      Getter for name The name of this company, as shown to customers.

    • setName

      public void setName(String value)
      Setter for name The name of this company, as shown to customers.

    • getIsDefault

      public 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(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 Integer getDefaultLocationId()
      Getter for defaultLocationId If set, this is the unique ID number of the default location for this company.

    • setDefaultLocationId

      public void setDefaultLocationId(Integer value)
      Setter for defaultLocationId If set, this is the unique ID number of the default location for this company.

    • getIsActive

      public 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(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 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(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 Boolean getIsFein()
      Getter for isFein Set this field to true if the taxPayerIdNumber is a FEIN.

    • setIsFein

      public void setIsFein(Boolean value)
      Setter for isFein Set this field to true if the taxPayerIdNumber is a FEIN.

    • getHasProfile

      public 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(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 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(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 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(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 String getDefaultCountry()
      Getter for defaultCountry The two character ISO-3166 country code of the default country for this company.

    • setDefaultCountry

      public void setDefaultCountry(String value)
      Setter for defaultCountry The two character ISO-3166 country code of the default country for this company.

    • getBaseCurrencyCode

      public 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(String value)
      Setter for baseCurrencyCode This is the three character ISO-4217 currency code of the default currency used by this company.

    • getRoundingLevelId

      public RoundingLevelId getRoundingLevelId()
      Getter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level.

    • setRoundingLevelId

      public void setRoundingLevelId(RoundingLevelId value)
      Setter for roundingLevelId Indicates whether this company prefers to round amounts at the document level or line level.

    • getWarningsEnabled

      public Boolean getWarningsEnabled()
      Getter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP.

    • setWarningsEnabled

      public void setWarningsEnabled(Boolean value)
      Setter for warningsEnabled Set this value to true to receive warnings in API calls via SOAP.

    • getIsTest

      public 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(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

      public TaxDependencyLevelId getTaxDependencyLevelId()
      Getter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level.

    • setTaxDependencyLevelId

      public void setTaxDependencyLevelId(TaxDependencyLevelId value)
      Setter for taxDependencyLevelId Used to apply tax detail dependency at a jurisdiction level.

    • getInProgress

      public 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(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 String getBusinessIdentificationNo()
      Getter for businessIdentificationNo Business Identification No

    • setBusinessIdentificationNo

      public void setBusinessIdentificationNo(String value)
      Setter for businessIdentificationNo Business Identification No

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

    • getContacts

      public ArrayList<ContactModel> 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

      public void setContacts(ArrayList<ContactModel> value)
      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

      public ArrayList<ItemModel> 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

      public void setItems(ArrayList<ItemModel> value)
      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

      public ArrayList<LocationModel> 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

      public void setLocations(ArrayList<LocationModel> value)
      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

      public ArrayList<NexusModel> 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

      public void setNexus(ArrayList<NexusModel> value)
      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

      public ArrayList<SettingModel> 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

      public void setSettings(ArrayList<SettingModel> value)
      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

      public ArrayList<TaxCodeModel> 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

      public void setTaxCodes(ArrayList<TaxCodeModel> value)
      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

      public ArrayList<TaxRuleModel> 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

      public void setTaxRules(ArrayList<TaxRuleModel> value)
      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

      public ArrayList<UPCModel> 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

      public void setUpcs(ArrayList<UPCModel> value)
      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

      public ArrayList<CompanyModel> 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

      public void setNonReportingChildCompanies(ArrayList<CompanyModel> value)
      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

      public ArrayList<EcmsModel> getExemptCerts()
      Getter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API.

    • setExemptCerts

      public void setExemptCerts(ArrayList<EcmsModel> value)
      Setter for exemptCerts DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API.

    • getMossId

      public 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(String value)
      Setter for mossId The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing.

    • getMossCountry

      public 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(String value)
      Setter for mossCountry The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing.

    • getParameters

      public ArrayList<CompanyParameterDetailModel> getParameters()
      Getter for parameters The parameters of a company

    • setParameters

      public void setParameters(ArrayList<CompanyParameterDetailModel> value)
      Setter for parameters The parameters of a company

    • getSupplierandcustomers

      public ArrayList<CustomerSupplierModel> getSupplierandcustomers()
      Getter for supplierandcustomers The customers and suppliers of a company

    • setSupplierandcustomers

      public void setSupplierandcustomers(ArrayList<CustomerSupplierModel> value)
      Setter for supplierandcustomers The customers and suppliers of a company

    • toString

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