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

Class CustomerModel

java.lang.Object
net.avalara.avatax.rest.client.models.CustomerModel
public class CustomerModel extends Object
Represents a customer to whom you sell products and/or services.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomerModel()
     

  • Method Summary

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

    • CustomerModel

      public CustomerModel()

  • Method Details

    • getId

      public Integer getId()
      Getter for id Unique ID number of this customer.

    • setId

      public void setId(Integer value)
      Setter for id Unique ID number of this customer.

    • getCompanyId

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

    • setCompanyId

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

    • getCustomerCode

      public 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(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 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(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 String getName()
      Getter for name A friendly name identifying this customer.

    • setName

      public void setName(String value)
      Setter for name A friendly name identifying this customer.

    • getAttnName

      public 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(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 String getLine1()
      Getter for line1 First line of the street address of this customer.

    • setLine1

      public void setLine1(String value)
      Setter for line1 First line of the street address of this customer.

    • getLine2

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

    • setLine2

      public void setLine2(String value)
      Setter for line2 Second line of the street address of this customer.

    • getCity

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

    • setCity

      public void setCity(String value)
      Setter for city City component of the street address of this customer.

    • getPostalCode

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

    • setPostalCode

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

    • getPhoneNumber

      public String getPhoneNumber()
      Getter for phoneNumber The main phone number for this customer.

    • setPhoneNumber

      public void setPhoneNumber(String value)
      Setter for phoneNumber The main phone number for this customer.

    • getFaxNumber

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

    • setFaxNumber

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

    • getEmailAddress

      public String getEmailAddress()
      Getter for emailAddress The main email address for this customer.

    • setEmailAddress

      public void setEmailAddress(String value)
      Setter for emailAddress The main email address for this customer.

    • getContactName

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

    • setContactName

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

    • getLastTransaction

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

    • setLastTransaction

      public void setLastTransaction(Date value)
      Setter for lastTransaction Date when this customer last executed a transaction.

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

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

    • getCountry

      public 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(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 String getRegion()
      Getter for region ISO 3166 code identifying the region within the country. Two and three character ISO 3166 region codes. This is a required field if the country is US or CA. For other countries, this is an optional field. For a full list of all supported codes, please see the Definitions API `ListRegions`.

    • setRegion

      public void setRegion(String value)
      Setter for region ISO 3166 code identifying the region within the country. Two and three character ISO 3166 region codes. This is a required field if the country is US or CA. For other countries, this is an optional field. For a full list of all supported codes, please see the Definitions API `ListRegions`.

    • getIsBill

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

    • setIsBill

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

    • getIsShip

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

    • setIsShip

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

    • getTaxpayerIdNumber

      public 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(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 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(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 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(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 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(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 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(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 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(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 String toString()
      Returns a JSON string representation of CustomerModel
      Overrides:
      toString in class Object