Class UserModel


  • public class UserModel
    extends java.lang.Object
    An account user who is permitted to use AvaTax.
    • Constructor Summary

      Constructors 
      Constructor Description
      UserModel()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getAccountId()
      Getter for accountId The unique ID number of the account to which this user belongs.
      java.lang.Integer getCompanyId()
      Getter for companyId If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
      java.util.Date getCreatedDate()
      Getter for createdDate The date when this record was created.
      java.lang.String getEmail()
      Getter for email The email address to be used to contact this user.
      java.lang.String getFirstName()
      Getter for firstName The first or given name of the user.
      java.lang.Integer getId()
      Getter for id The unique ID number of this user.
      java.lang.Boolean getIsActive()
      Getter for isActive True if this user is currently active.
      java.lang.String getLastName()
      Getter for lastName The last or family name of the user.
      java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.
      PasswordStatusId getPasswordStatus()
      Getter for passwordStatus The status of the user's password.
      java.lang.String getPostalCode()
      Getter for postalCode The postal code in which this user resides.
      SecurityRoleId getSecurityRoleId()
      Getter for securityRoleId The security level for this user.
      java.lang.String getSubjectId()
      Getter for subjectId Matches the subjectId of corresponding user record in AI.
      java.lang.String getUserName()
      Getter for userName The username which is used to log on to the AvaTax website, or to authenticate against API calls.
      void setAccountId​(java.lang.Integer value)
      Setter for accountId The unique ID number of the account to which this user belongs.
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
      void setCreatedDate​(java.util.Date value)
      Setter for createdDate The date when this record was created.
      void setEmail​(java.lang.String value)
      Setter for email The email address to be used to contact this user.
      void setFirstName​(java.lang.String value)
      Setter for firstName The first or given name of the user.
      void setId​(java.lang.Integer value)
      Setter for id The unique ID number of this user.
      void setIsActive​(java.lang.Boolean value)
      Setter for isActive True if this user is currently active.
      void setLastName​(java.lang.String value)
      Setter for lastName The last or family name of the user.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.
      void setPasswordStatus​(PasswordStatusId value)
      Setter for passwordStatus The status of the user's password.
      void setPostalCode​(java.lang.String value)
      Setter for postalCode The postal code in which this user resides.
      void setSecurityRoleId​(SecurityRoleId value)
      Setter for securityRoleId The security level for this user.
      void setSubjectId​(java.lang.String value)
      Setter for subjectId Matches the subjectId of corresponding user record in AI.
      void setUserName​(java.lang.String value)
      Setter for userName The username which is used to log on to the AvaTax website, or to authenticate against API calls.
      java.lang.String toString()
      Returns a JSON string representation of UserModel
      • Methods inherited from class java.lang.Object

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

      • UserModel

        public UserModel()
    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id The unique ID number of this user.
      • setId

        public void setId​(java.lang.Integer value)
        Setter for id The unique ID number of this user.
      • getAccountId

        public java.lang.Integer getAccountId()
        Getter for accountId The unique ID number of the account to which this user belongs.
      • setAccountId

        public void setAccountId​(java.lang.Integer value)
        Setter for accountId The unique ID number of the account to which this user belongs.
      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs.
      • getUserName

        public java.lang.String getUserName()
        Getter for userName The username which is used to log on to the AvaTax website, or to authenticate against API calls.
      • setUserName

        public void setUserName​(java.lang.String value)
        Setter for userName The username which is used to log on to the AvaTax website, or to authenticate against API calls.
      • getFirstName

        public java.lang.String getFirstName()
        Getter for firstName The first or given name of the user.
      • setFirstName

        public void setFirstName​(java.lang.String value)
        Setter for firstName The first or given name of the user.
      • getLastName

        public java.lang.String getLastName()
        Getter for lastName The last or family name of the user.
      • setLastName

        public void setLastName​(java.lang.String value)
        Setter for lastName The last or family name of the user.
      • getEmail

        public java.lang.String getEmail()
        Getter for email The email address to be used to contact this user. If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password.
      • setEmail

        public void setEmail​(java.lang.String value)
        Setter for email The email address to be used to contact this user. If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password.
      • getPostalCode

        public java.lang.String getPostalCode()
        Getter for postalCode The postal code in which this user resides.
      • setPostalCode

        public void setPostalCode​(java.lang.String value)
        Setter for postalCode The postal code in which this user resides.
      • getSecurityRoleId

        public SecurityRoleId getSecurityRoleId()
        Getter for securityRoleId The security level for this user.
      • setSecurityRoleId

        public void setSecurityRoleId​(SecurityRoleId value)
        Setter for securityRoleId The security level for this user.
      • getPasswordStatus

        public PasswordStatusId getPasswordStatus()
        Getter for passwordStatus The status of the user's password. For a new user created, this is always going to be `UserMustChange`
      • setPasswordStatus

        public void setPasswordStatus​(PasswordStatusId value)
        Setter for passwordStatus The status of the user's password. For a new user created, this is always going to be `UserMustChange`
      • getIsActive

        public java.lang.Boolean getIsActive()
        Getter for isActive True if this user is currently active.
      • setIsActive

        public void setIsActive​(java.lang.Boolean value)
        Setter for isActive True if this user is currently active.
      • 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.
      • getSubjectId

        public java.lang.String getSubjectId()
        Getter for subjectId Matches the subjectId of corresponding user record in AI.
      • setSubjectId

        public void setSubjectId​(java.lang.String value)
        Setter for subjectId Matches the subjectId of corresponding user record in AI.
      • toString

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