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 and Description

CompanyModel()

Constructors
Constructor and Description
`CompanyModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 No
`java.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.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`	`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`	`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.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<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 accountId)` Setter for accountId - The unique ID number of the account this company belongs to.
`void`	`setBaseCurrencyCode(java.lang.String baseCurrencyCode)` 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 businessIdentificationNo)` Setter for businessIdentificationNo - Business Identification No
`void`	`setCompanyCode(java.lang.String companyCode)` Setter for companyCode - A unique code that references this company within your account.
`void`	`setContacts(java.util.ArrayList<ContactModel> contacts)` Setter for contacts - Optional: A list of contacts defined for this company.
`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`	`setDefaultCountry(java.lang.String defaultCountry)` Setter for defaultCountry - The two character ISO-3166 country code of the default country for this company.
`void`	`setDefaultLocationId(java.lang.Integer defaultLocationId)` Setter for defaultLocationId - If set, this is the unique ID number of the default location for this company.
`void`	`setHasProfile(java.lang.Boolean hasProfile)` Setter for hasProfile - Set this flag to true to give this company its own unique tax profile.
`void`	`setId(java.lang.Integer id)` Setter for id - The unique ID number of this company.
`void`	`setInProgress(java.lang.Boolean inProgress)` 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 isActive)` Setter for isActive - This flag indicates whether tax activity can occur for this company.
`void`	`setIsDefault(java.lang.Boolean isDefault)` Setter for isDefault - This flag is true if this company is the default company for this account.
`void`	`setIsReportingEntity(java.lang.Boolean isReportingEntity)` Setter for isReportingEntity - Set this flag to true if this company must file its own tax returns.
`void`	`setIsTest(java.lang.Boolean isTest)` Setter for isTest - Set this flag to true to indicate that this company is a test company.
`void`	`setItems(java.util.ArrayList<ItemModel> items)` Setter for items - Optional: A list of items defined for this company.
`void`	`setLocations(java.util.ArrayList<LocationModel> locations)` Setter for locations - Optional: A list of locations defined for this company.
`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`	`setName(java.lang.String name)` Setter for name - The name of this company, as shown to customers.
`void`	`setNexus(java.util.ArrayList<NexusModel> nexus)` Setter for nexus - Optional: A list of nexus defined for this company.
`void`	`setParentCompanyId(java.lang.Integer parentCompanyId)` Setter for parentCompanyId - If this company is fully owned by another company, this is the unique identity of the parent company.
`void`	`setRoundingLevelId(RoundingLevelId roundingLevelId)` Setter for roundingLevelId - Indicates whether this company prefers to round amounts at the document level or line level.
`void`	`setSettings(java.util.ArrayList<SettingModel> settings)` Setter for settings - Optional: A list of settings defined for this company.
`void`	`setSstEffectiveDate(java.util.Date sstEffectiveDate)` 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 sstPid)` 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`	`setTaxCodes(java.util.ArrayList<TaxCodeModel> taxCodes)` Setter for taxCodes - Optional: A list of tax codes defined for this company.
`void`	`setTaxDependencyLevelId(TaxDependencyLevelId taxDependencyLevelId)` Setter for taxDependencyLevelId - Used to apply tax detail dependency at a jurisdiction level.
`void`	`setTaxpayerIdNumber(java.lang.String taxpayerIdNumber)` Setter for taxpayerIdNumber - For United States companies, this field contains your Taxpayer Identification Number.
`void`	`setTaxRules(java.util.ArrayList<TaxRuleModel> taxRules)` Setter for taxRules - Optional: A list of tax rules defined for this company.
`void`	`setUpcs(java.util.ArrayList<UPCModel> upcs)` Setter for upcs - Optional: A list of UPCs defined for this company.
`void`	`setWarningsEnabled(java.lang.Boolean warningsEnabled)` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CompanyModel
```
public CompanyModel()
```
- Method Detail
  - getLocations
```
public java.util.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.
  - setLocations
```
public void setLocations(java.util.ArrayList<LocationModel> locations)
```
    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.
  - 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 name)
```
    Setter for name - The name of this company, as shown to customers.
  - getTaxCodes
```
public java.util.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.
  - setTaxCodes
```
public void setTaxCodes(java.util.ArrayList<TaxCodeModel> taxCodes)
```
    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.
  - getNexus
```
public java.util.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.
  - setNexus
```
public void setNexus(java.util.ArrayList<NexusModel> nexus)
```
    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.
  - 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 companyCode)
```
    Setter for companyCode - A unique code that references this company within your account.
  - 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.
  - getItems
```
public java.util.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.
  - setItems
```
public void setItems(java.util.ArrayList<ItemModel> items)
```
    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.
  - getBusinessIdentificationNo
```
public java.lang.String getBusinessIdentificationNo()
```
    Getter for businessIdentificationNo - Business Identification No
  - setBusinessIdentificationNo
```
public void setBusinessIdentificationNo(java.lang.String businessIdentificationNo)
```
    Setter for businessIdentificationNo - Business Identification No
  - 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 isReportingEntity)
```
    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.
  - getUpcs
```
public java.util.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.
  - setUpcs
```
public void setUpcs(java.util.ArrayList<UPCModel> upcs)
```
    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.
  - 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 you subscribe to Avalara Managed Returns or the SST Certified Service Provider services, but it is optional if you do not subscribe to either of those services.
  - setTaxpayerIdNumber
```
public void setTaxpayerIdNumber(java.lang.String taxpayerIdNumber)
```
    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 you subscribe to Avalara Managed Returns or the SST Certified Service Provider services, but it is optional if you do not subscribe to either of those services.
  - 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 accountId)
```
    Setter for accountId - The unique ID number of the account this company belongs to.
  - 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 sstPid)
```
    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.
  - getContacts
```
public java.util.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.
  - setContacts
```
public void setContacts(java.util.ArrayList<ContactModel> contacts)
```
    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.
  - 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 sstEffectiveDate)
```
    Setter for sstEffectiveDate - If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program.
  - getTaxRules
```
public java.util.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.
  - setTaxRules
```
public void setTaxRules(java.util.ArrayList<TaxRuleModel> taxRules)
```
    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.
  - 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 roundingLevelId)
```
    Setter for roundingLevelId - Indicates whether this company prefers to round amounts at the document level or line level.
  - getTaxDependencyLevelId
```
public TaxDependencyLevelId getTaxDependencyLevelId()
```
    Getter for taxDependencyLevelId - Used to apply tax detail dependency at a jurisdiction level.
  - setTaxDependencyLevelId
```
public void setTaxDependencyLevelId(TaxDependencyLevelId taxDependencyLevelId)
```
    Setter for taxDependencyLevelId - Used to apply tax detail dependency at a jurisdiction level.
  - getId
```
public java.lang.Integer getId()
```
    Getter for id - The unique ID number of this company.
  - setId
```
public void setId(java.lang.Integer id)
```
    Setter for id - The unique ID number of this company.
  - 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 isTest)
```
    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.
  - 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 warningsEnabled)
```
    Setter for warningsEnabled - Set this value to true to receive warnings in API calls via SOAP.
  - 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 defaultCountry)
```
    Setter for defaultCountry - The two character ISO-3166 country code of the default country 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 isActive)
```
    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.
  - 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.
  - 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.
  - 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 defaultLocationId)
```
    Setter for defaultLocationId - If set, this is the unique ID number of the default location for this company.
  - 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 inProgress)
```
    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.
  - 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 parentCompanyId)
```
    Setter for parentCompanyId - If this company is fully owned by another company, this is the unique identity of the parent company.
  - 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 hasProfile)
```
    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.
  - 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 baseCurrencyCode)
```
    Setter for baseCurrencyCode - This is the three character ISO-4217 currency code of the default currency used by this company.
  - getSettings
```
public java.util.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.
  - setSettings
```
public void setSettings(java.util.ArrayList<SettingModel> settings)
```
    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.
  - 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 isDefault)
```
    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.
  - 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.
  - toString
```
public java.lang.String toString()
```
    Returns a JSON string representation of CompanyModel.
    
    Overrides:
    
    toString in class java.lang.Object

Class CompanyModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompanyModel

Method Detail

getLocations

setLocations

getName

setName

getTaxCodes

setTaxCodes

getNexus

setNexus

getCompanyCode

setCompanyCode

getModifiedDate

setModifiedDate

getItems

setItems

getBusinessIdentificationNo

setBusinessIdentificationNo

getIsReportingEntity

setIsReportingEntity

getUpcs

setUpcs

getTaxpayerIdNumber

setTaxpayerIdNumber

getAccountId

setAccountId

getSstPid

setSstPid

getContacts

setContacts

getSstEffectiveDate

setSstEffectiveDate

getTaxRules

setTaxRules

getRoundingLevelId

setRoundingLevelId

getTaxDependencyLevelId

setTaxDependencyLevelId

getId

setId

getIsTest

setIsTest

getWarningsEnabled

setWarningsEnabled

getDefaultCountry

setDefaultCountry

getIsActive

setIsActive

getModifiedUserId

setModifiedUserId

getCreatedUserId

setCreatedUserId

getDefaultLocationId

setDefaultLocationId

getInProgress

setInProgress

getParentCompanyId

setParentCompanyId

getHasProfile

setHasProfile

getBaseCurrencyCode

setBaseCurrencyCode

getSettings

setSettings

getIsDefault

setIsDefault

getCreatedDate

setCreatedDate

toString