Class CustomerModel


  • public class CustomerModel
    extends java.lang.Object
    Represents a customer to whom you sell products and/or services.
    • Constructor Summary

      Constructors 
      Constructor Description
      CustomerModel()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAlternateId()
      Getter for alternateId A customer-configurable alternate ID number for this customer.
      java.lang.String getAttnName()
      Getter for attnName Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name.
      java.util.ArrayList<CustomerAttributeModel> getAttributes()
      Getter for attributes A list of attributes that apply to this customer.
      java.util.ArrayList<CertificateModel> getCertificates()
      Getter for certificates A list of exemption certficates that apply to this customer.
      java.lang.String getCity()
      Getter for city City component of the street address of this customer.
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the AvaTax company that recorded this customer.
      java.lang.String getContactName()
      Getter for contactName The name of the main contact person for this customer.
      java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country.
      java.util.Date getCreatedDate()
      Getter for createdDate The date when this record was created.
      java.lang.String getCustomerCode()
      Getter for customerCode The unique code identifying this customer.
      java.util.ArrayList<CustomFieldModel> getCustomFields()
      Getter for customFields A list of custom fields defined on this customer.
      java.lang.String getEmailAddress()
      Getter for emailAddress The main email address for this customer.
      java.util.ArrayList<ExposureZoneModel> getExposureZones()
      Getter for exposureZones A list of exposure zones where you do business with this customer.
      java.lang.String getFaxNumber()
      Getter for faxNumber The fax phone number for this customer, if any.
      java.lang.Integer getId()
      Getter for id Unique ID number of this customer.
      java.lang.Boolean getIsBill()
      Getter for isBill True if this customer record is specifically used for bill-to purposes.
      java.lang.Boolean getIsShip()
      Getter for isShip True if this customer record is specifically used for ship-to purposes.
      java.util.Date getLastTransaction()
      Getter for lastTransaction Date when this customer last executed a transaction.
      java.lang.String getLine1()
      Getter for line1 First line of the street address of this customer.
      java.lang.String getLine2()
      Getter for line2 Second line of the street address of this customer.
      java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.
      java.lang.String getName()
      Getter for name A friendly name identifying this customer.
      java.lang.String getPhoneNumber()
      Getter for phoneNumber The main phone number for this customer.
      java.lang.String getPostalCode()
      Getter for postalCode Postal Code / Zip Code component of the address of this customer.
      java.lang.String getRegion()
      Getter for region ISO 3166 code identifying the region within the country.
      java.util.ArrayList<CustomerModel> getShipTos()
      Getter for shipTos A list of ship-to customer records that are connected to this bill-to customer.
      java.lang.String getTaxpayerIdNumber()
      Getter for taxpayerIdNumber For customers in the United States, this field is the federal taxpayer ID number.
      void setAlternateId​(java.lang.String value)
      Setter for alternateId A customer-configurable alternate ID number for this customer.
      void setAttnName​(java.lang.String value)
      Setter for attnName Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name.
      void setAttributes​(java.util.ArrayList<CustomerAttributeModel> value)
      Setter for attributes A list of attributes that apply to this customer.
      void setCertificates​(java.util.ArrayList<CertificateModel> value)
      Setter for certificates A list of exemption certficates that apply to this customer.
      void setCity​(java.lang.String value)
      Setter for city City component of the street address of this customer.
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the AvaTax company that recorded this customer.
      void setContactName​(java.lang.String value)
      Setter for contactName The name of the main contact person for this customer.
      void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country.
      void setCreatedDate​(java.util.Date value)
      Setter for createdDate The date when this record was created.
      void setCustomerCode​(java.lang.String value)
      Setter for customerCode The unique code identifying this customer.
      void setCustomFields​(java.util.ArrayList<CustomFieldModel> value)
      Setter for customFields A list of custom fields defined on this customer.
      void setEmailAddress​(java.lang.String value)
      Setter for emailAddress The main email address for this customer.
      void setExposureZones​(java.util.ArrayList<ExposureZoneModel> value)
      Setter for exposureZones A list of exposure zones where you do business with this customer.
      void setFaxNumber​(java.lang.String value)
      Setter for faxNumber The fax phone number for this customer, if any.
      void setId​(java.lang.Integer value)
      Setter for id Unique ID number of this customer.
      void setIsBill​(java.lang.Boolean value)
      Setter for isBill True if this customer record is specifically used for bill-to purposes.
      void setIsShip​(java.lang.Boolean value)
      Setter for isShip True if this customer record is specifically used for ship-to purposes.
      void setLastTransaction​(java.util.Date value)
      Setter for lastTransaction Date when this customer last executed a transaction.
      void setLine1​(java.lang.String value)
      Setter for line1 First line of the street address of this customer.
      void setLine2​(java.lang.String value)
      Setter for line2 Second line of the street address of this customer.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.
      void setName​(java.lang.String value)
      Setter for name A friendly name identifying this customer.
      void setPhoneNumber​(java.lang.String value)
      Setter for phoneNumber The main phone number for this customer.
      void setPostalCode​(java.lang.String value)
      Setter for postalCode Postal Code / Zip Code component of the address of this customer.
      void setRegion​(java.lang.String value)
      Setter for region ISO 3166 code identifying the region within the country.
      void setShipTos​(java.util.ArrayList<CustomerModel> value)
      Setter for shipTos A list of ship-to customer records that are connected to this bill-to customer.
      void setTaxpayerIdNumber​(java.lang.String value)
      Setter for taxpayerIdNumber For customers in the United States, this field is the federal taxpayer ID number.
      java.lang.String toString()
      Returns a JSON string representation of CustomerModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CustomerModel

        public CustomerModel()
    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id Unique ID number of this customer.
      • setId

        public void setId​(java.lang.Integer value)
        Setter for id Unique ID number of this customer.
      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId The unique ID number of the AvaTax company that recorded this customer.
      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId The unique ID number of the AvaTax company that recorded this customer.
      • getCustomerCode

        public java.lang.String getCustomerCode()
        Getter for customerCode The unique code identifying this customer. Must be unique within your company. This code should be used in the `customerCode` field of any call that creates or adjusts a transaction in order to ensure that all exemptions that apply to this customer are correctly considered. Note: This field is case sensitive.
      • setCustomerCode

        public void setCustomerCode​(java.lang.String value)
        Setter for customerCode The unique code identifying this customer. Must be unique within your company. This code should be used in the `customerCode` field of any call that creates or adjusts a transaction in order to ensure that all exemptions that apply to this customer are correctly considered. Note: This field is case sensitive.
      • getAlternateId

        public java.lang.String getAlternateId()
        Getter for alternateId A customer-configurable alternate ID number for this customer. You may set this value to match any other system that would like to reference this customer record.
      • setAlternateId

        public void setAlternateId​(java.lang.String value)
        Setter for alternateId A customer-configurable alternate ID number for this customer. You may set this value to match any other system that would like to reference this customer record.
      • getName

        public java.lang.String getName()
        Getter for name A friendly name identifying this customer.
      • setName

        public void setName​(java.lang.String value)
        Setter for name A friendly name identifying this customer.
      • getAttnName

        public java.lang.String getAttnName()
        Getter for attnName Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name.
      • setAttnName

        public void setAttnName​(java.lang.String value)
        Setter for attnName Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name.
      • getLine1

        public java.lang.String getLine1()
        Getter for line1 First line of the street address of this customer.
      • setLine1

        public void setLine1​(java.lang.String value)
        Setter for line1 First line of the street address of this customer.
      • getLine2

        public java.lang.String getLine2()
        Getter for line2 Second line of the street address of this customer.
      • setLine2

        public void setLine2​(java.lang.String value)
        Setter for line2 Second line of the street address of this customer.
      • getCity

        public java.lang.String getCity()
        Getter for city City component of the street address of this customer.
      • setCity

        public void setCity​(java.lang.String value)
        Setter for city City component of the street address of this customer.
      • getPostalCode

        public java.lang.String getPostalCode()
        Getter for postalCode Postal Code / Zip Code component of the address of this customer.
      • setPostalCode

        public void setPostalCode​(java.lang.String value)
        Setter for postalCode Postal Code / Zip Code component of the address of this customer.
      • getPhoneNumber

        public java.lang.String getPhoneNumber()
        Getter for phoneNumber The main phone number for this customer.
      • setPhoneNumber

        public void setPhoneNumber​(java.lang.String value)
        Setter for phoneNumber The main phone number for this customer.
      • getFaxNumber

        public java.lang.String getFaxNumber()
        Getter for faxNumber The fax phone number for this customer, if any.
      • setFaxNumber

        public void setFaxNumber​(java.lang.String value)
        Setter for faxNumber The fax phone number for this customer, if any.
      • getEmailAddress

        public java.lang.String getEmailAddress()
        Getter for emailAddress The main email address for this customer.
      • setEmailAddress

        public void setEmailAddress​(java.lang.String value)
        Setter for emailAddress The main email address for this customer.
      • getContactName

        public java.lang.String getContactName()
        Getter for contactName The name of the main contact person for this customer.
      • setContactName

        public void setContactName​(java.lang.String value)
        Setter for contactName The name of the main contact person for this customer.
      • getLastTransaction

        public java.util.Date getLastTransaction()
        Getter for lastTransaction Date when this customer last executed a transaction.
      • setLastTransaction

        public void setLastTransaction​(java.util.Date value)
        Setter for lastTransaction Date when this customer last executed a transaction.
      • 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.
      • 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.
      • getCountry

        public java.lang.String getCountry()
        Getter for country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
      • setCountry

        public void setCountry​(java.lang.String value)
        Setter for country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
      • getRegion

        public java.lang.String getRegion()
        Getter for region ISO 3166 code identifying the region within the country. Two and three character ISO 3166 region codes. For a full list of all supported codes, please see the Definitions API `ListRegions`.
      • setRegion

        public void setRegion​(java.lang.String value)
        Setter for region ISO 3166 code identifying the region within the country. Two and three character ISO 3166 region codes. For a full list of all supported codes, please see the Definitions API `ListRegions`.
      • getIsBill

        public java.lang.Boolean getIsBill()
        Getter for isBill True if this customer record is specifically used for bill-to purposes.
      • setIsBill

        public void setIsBill​(java.lang.Boolean value)
        Setter for isBill True if this customer record is specifically used for bill-to purposes.
      • getIsShip

        public java.lang.Boolean getIsShip()
        Getter for isShip True if this customer record is specifically used for ship-to purposes.
      • setIsShip

        public void setIsShip​(java.lang.Boolean value)
        Setter for isShip True if this customer record is specifically used for ship-to purposes.
      • getTaxpayerIdNumber

        public java.lang.String getTaxpayerIdNumber()
        Getter for taxpayerIdNumber For customers in the United States, this field is the federal taxpayer ID number. For businesses, this is a Federal Employer Identification Number. For individuals, this will be a Social Security Number.
      • setTaxpayerIdNumber

        public void setTaxpayerIdNumber​(java.lang.String value)
        Setter for taxpayerIdNumber For customers in the United States, this field is the federal taxpayer ID number. For businesses, this is a Federal Employer Identification Number. For individuals, this will be a Social Security Number.
      • getCertificates

        public java.util.ArrayList<CertificateModel> getCertificates()
        Getter for certificates A list of exemption certficates that apply to this customer. You can fetch this data by specifying `$include=certificates` when calling a customer fetch API.
      • setCertificates

        public void setCertificates​(java.util.ArrayList<CertificateModel> value)
        Setter for certificates A list of exemption certficates that apply to this customer. You can fetch this data by specifying `$include=certificates` when calling a customer fetch API.
      • getCustomFields

        public java.util.ArrayList<CustomFieldModel> getCustomFields()
        Getter for customFields A list of custom fields defined on this customer. For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers).
      • setCustomFields

        public void setCustomFields​(java.util.ArrayList<CustomFieldModel> value)
        Setter for customFields A list of custom fields defined on this customer. For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers).
      • getExposureZones

        public java.util.ArrayList<ExposureZoneModel> getExposureZones()
        Getter for exposureZones A list of exposure zones where you do business with this customer. To keep track of certificates that are needed for each customer, set this value to a list of all exposure zones where you sell products to this customer. You can find a list of exposure zones by calling `ListExposureZones`. This field is often called "Ship-To States" or "Ship-To Zones", since it generally refers to locations where you ship products when this customer makes a purchase. This field is useful for audit purposes since it helps you ensure you have the necessary certificates for each customer.
      • setExposureZones

        public void setExposureZones​(java.util.ArrayList<ExposureZoneModel> value)
        Setter for exposureZones A list of exposure zones where you do business with this customer. To keep track of certificates that are needed for each customer, set this value to a list of all exposure zones where you sell products to this customer. You can find a list of exposure zones by calling `ListExposureZones`. This field is often called "Ship-To States" or "Ship-To Zones", since it generally refers to locations where you ship products when this customer makes a purchase. This field is useful for audit purposes since it helps you ensure you have the necessary certificates for each customer.
      • getShipTos

        public java.util.ArrayList<CustomerModel> getShipTos()
        Getter for shipTos A list of ship-to customer records that are connected to this bill-to customer. Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these customer records together, you may link multiple bill-to and ship-to addresses together to represent a single entity that has multiple different addresses of different kinds.
      • setShipTos

        public void setShipTos​(java.util.ArrayList<CustomerModel> value)
        Setter for shipTos A list of ship-to customer records that are connected to this bill-to customer. Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these customer records together, you may link multiple bill-to and ship-to addresses together to represent a single entity that has multiple different addresses of different kinds.
      • getAttributes

        public java.util.ArrayList<CustomerAttributeModel> getAttributes()
        Getter for attributes A list of attributes that apply to this customer. You can fetch this data by specifying `$include=attributes` when calling a customer fetch API.
      • setAttributes

        public void setAttributes​(java.util.ArrayList<CustomerAttributeModel> value)
        Setter for attributes A list of attributes that apply to this customer. You can fetch this data by specifying `$include=attributes` when calling a customer fetch API.
      • toString

        public java.lang.String toString()
        Returns a JSON string representation of CustomerModel
        Overrides:
        toString in class java.lang.Object