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

Class NotificationModel

java.lang.Object
net.avalara.avatax.rest.client.models.NotificationModel
public class NotificationModel extends Object
Represents a single notification. A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification. An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NotificationModel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getAccountId()
    Getter for accountId The unique ID number of the account that received this notification.
    Date
    getActionDueDate()
    Getter for actionDueDate If there is a specific action suggested by this notification, and if this action is requested by a specific due date, this value will be the due date for the action.
    String
    getActionLink()
    Getter for actionLink If there is a specific action suggested by this notification, this is the URL of the action.
    String
    getActionName()
    Getter for actionName If there is a specific action suggested by this notification, this is the name of the action.
    String
    getCategory()
    Getter for category The category of this notification.
    Integer
    getCompanyId()
    Getter for companyId If this notification was tied to a specific company, this will be the unique ID number of the company that received the notification.
    Date
    getCreatedDate()
    Getter for createdDate The UTC timestamp of the time when this notification was created.
    Integer
    getCreatedUserId()
    Getter for createdUserId The unique ID number of the user who created the notification.
    Boolean
    getDismissed()
    Getter for dismissed When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API.
    Integer
    getDismissedByUserId()
    Getter for dismissedByUserId If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.
    Date
    getDismissedDate()
    Getter for dismissedDate If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.
    Date
    getExpireDate()
    Getter for expireDate If this notification is time sensitive, this is the latest date when the notification should be displayed to the user.
    Long
    getId()
    Getter for id The unique id of the notification.
    String
    getMessage()
    Getter for message The message for this notification.
    Date
    getModifiedDate()
    Getter for modifiedDate The UTC timestamp of the time when this notification was last modified.
    Integer
    getModifiedUserId()
    Getter for modifiedUserId The unique ID number of the user who most recently modified this notification.
    Boolean
    getNeedsAction()
    Getter for needsAction If this notification object requires user action to resolve, this value will be set to true.
    Long
    getReferenceId()
    Getter for referenceId The unique reference Id number of the object referred to by this notification, if any.
    String
    getReferenceObject()
    Getter for referenceObject The type name of object referred to by this notification, if any.
    NotificationSeverityLevel
    getSeverityLevelId()
    Getter for severityLevelId The severity level of the notification.
    String
    getTopic()
    Getter for topic The topic of this notification.
    void
    setAccountId(Integer value)
    Setter for accountId The unique ID number of the account that received this notification.
    void
    setActionDueDate(Date value)
    Setter for actionDueDate If there is a specific action suggested by this notification, and if this action is requested by a specific due date, this value will be the due date for the action.
    void
    setActionLink(String value)
    Setter for actionLink If there is a specific action suggested by this notification, this is the URL of the action.
    void
    setActionName(String value)
    Setter for actionName If there is a specific action suggested by this notification, this is the name of the action.
    void
    setCategory(String value)
    Setter for category The category of this notification.
    void
    setCompanyId(Integer value)
    Setter for companyId If this notification was tied to a specific company, this will be the unique ID number of the company that received the notification.
    void
    setCreatedDate(Date value)
    Setter for createdDate The UTC timestamp of the time when this notification was created.
    void
    setCreatedUserId(Integer value)
    Setter for createdUserId The unique ID number of the user who created the notification.
    void
    setDismissed(Boolean value)
    Setter for dismissed When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API.
    void
    setDismissedByUserId(Integer value)
    Setter for dismissedByUserId If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.
    void
    setDismissedDate(Date value)
    Setter for dismissedDate If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.
    void
    setExpireDate(Date value)
    Setter for expireDate If this notification is time sensitive, this is the latest date when the notification should be displayed to the user.
    void
    setId(Long value)
    Setter for id The unique id of the notification.
    void
    setMessage(String value)
    Setter for message The message for this notification.
    void
    setModifiedDate(Date value)
    Setter for modifiedDate The UTC timestamp of the time when this notification was last modified.
    void
    setModifiedUserId(Integer value)
    Setter for modifiedUserId The unique ID number of the user who most recently modified this notification.
    void
    setNeedsAction(Boolean value)
    Setter for needsAction If this notification object requires user action to resolve, this value will be set to true.
    void
    setReferenceId(Long value)
    Setter for referenceId The unique reference Id number of the object referred to by this notification, if any.
    void
    setReferenceObject(String value)
    Setter for referenceObject The type name of object referred to by this notification, if any.
    void
    setSeverityLevelId(NotificationSeverityLevel value)
    Setter for severityLevelId The severity level of the notification.
    void
    setTopic(String value)
    Setter for topic The topic of this notification.
    String
    toString()
    Returns a JSON string representation of NotificationModel

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • NotificationModel

      public NotificationModel()

  • Method Details

    • getId

      public Long getId()
      Getter for id The unique id of the notification.

    • setId

      public void setId(Long value)
      Setter for id The unique id of the notification.

    • getAccountId

      public Integer getAccountId()
      Getter for accountId The unique ID number of the account that received this notification.

    • setAccountId

      public void setAccountId(Integer value)
      Setter for accountId The unique ID number of the account that received this notification.

    • getCompanyId

      public Integer getCompanyId()
      Getter for companyId If this notification was tied to a specific company, this will be the unique ID number of the company that received the notification. Notifications that are tied to accounts will have a `NULL` value for `companyId`.

    • setCompanyId

      public void setCompanyId(Integer value)
      Setter for companyId If this notification was tied to a specific company, this will be the unique ID number of the company that received the notification. Notifications that are tied to accounts will have a `NULL` value for `companyId`.

    • getReferenceObject

      public String getReferenceObject()
      Getter for referenceObject The type name of object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus.

    • setReferenceObject

      public void setReferenceObject(String value)
      Setter for referenceObject The type name of object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus.

    • getReferenceId

      public Long getReferenceId()
      Getter for referenceId The unique reference Id number of the object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus.

    • setReferenceId

      public void setReferenceId(Long value)
      Setter for referenceId The unique reference Id number of the object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus.

    • getSeverityLevelId

      public NotificationSeverityLevel getSeverityLevelId()
      Getter for severityLevelId The severity level of the notification.

    • setSeverityLevelId

      public void setSeverityLevelId(NotificationSeverityLevel value)
      Setter for severityLevelId The severity level of the notification.

    • getCategory

      public String getCategory()
      Getter for category The category of this notification. Notification categories are a useful way to group related notifications together. Category names may change over time. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".

    • setCategory

      public void setCategory(String value)
      Setter for category The category of this notification. Notification categories are a useful way to group related notifications together. Category names may change over time. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".

    • getTopic

      public String getTopic()
      Getter for topic The topic of this notification. Notification topics contain information about the notification. They are a summary of the issue and can help you decide what type of action to take. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".

    • setTopic

      public void setTopic(String value)
      Setter for topic The topic of this notification. Notification topics contain information about the notification. They are a summary of the issue and can help you decide what type of action to take. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration".

    • getMessage

      public String getMessage()
      Getter for message The message for this notification. This is a friendly description of the notification and any relevant information that can help you decide what kind of action, if any, to take in response.

    • setMessage

      public void setMessage(String value)
      Setter for message The message for this notification. This is a friendly description of the notification and any relevant information that can help you decide what kind of action, if any, to take in response.

    • getNeedsAction

      public Boolean getNeedsAction()
      Getter for needsAction If this notification object requires user action to resolve, this value will be set to true.

    • setNeedsAction

      public void setNeedsAction(Boolean value)
      Setter for needsAction If this notification object requires user action to resolve, this value will be set to true.

    • getActionName

      public String getActionName()
      Getter for actionName If there is a specific action suggested by this notification, this is the name of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`.

    • setActionName

      public void setActionName(String value)
      Setter for actionName If there is a specific action suggested by this notification, this is the name of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`.

    • getActionLink

      public String getActionLink()
      Getter for actionLink If there is a specific action suggested by this notification, this is the URL of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`.

    • setActionLink

      public void setActionLink(String value)
      Setter for actionLink If there is a specific action suggested by this notification, this is the URL of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`.

    • getActionDueDate

      public Date getActionDueDate()
      Getter for actionDueDate If there is a specific action suggested by this notification, and if this action is requested by a specific due date, this value will be the due date for the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`. For actions that have deadlines, such as "Confirm your tax registration before filing", this value will be set to the deadline date for the action. Otherwise, this value will be null.

    • setActionDueDate

      public void setActionDueDate(Date value)
      Setter for actionDueDate If there is a specific action suggested by this notification, and if this action is requested by a specific due date, this value will be the due date for the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`. For actions that have deadlines, such as "Confirm your tax registration before filing", this value will be set to the deadline date for the action. Otherwise, this value will be null.

    • getDismissed

      public Boolean getDismissed()
      Getter for dismissed When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API. This API marks the notification as dismissed, and dismissed notifications will generally not appear in most user interfaces.

    • setDismissed

      public void setDismissed(Boolean value)
      Setter for dismissed When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API. This API marks the notification as dismissed, and dismissed notifications will generally not appear in most user interfaces.

    • getDismissedByUserId

      public Integer getDismissedByUserId()
      Getter for dismissedByUserId If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.

    • setDismissedByUserId

      public void setDismissedByUserId(Integer value)
      Setter for dismissedByUserId If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.

    • getDismissedDate

      public Date getDismissedDate()
      Getter for dismissedDate If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.

    • setDismissedDate

      public void setDismissedDate(Date value)
      Setter for dismissedDate If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.

    • getExpireDate

      public Date getExpireDate()
      Getter for expireDate If this notification is time sensitive, this is the latest date when the notification should be displayed to the user.

    • setExpireDate

      public void setExpireDate(Date value)
      Setter for expireDate If this notification is time sensitive, this is the latest date when the notification should be displayed to the user.

    • getCreatedUserId

      public Integer getCreatedUserId()
      Getter for createdUserId The unique ID number of the user who created the notification.

    • setCreatedUserId

      public void setCreatedUserId(Integer value)
      Setter for createdUserId The unique ID number of the user who created the notification.

    • getCreatedDate

      public Date getCreatedDate()
      Getter for createdDate The UTC timestamp of the time when this notification was created.

    • setCreatedDate

      public void setCreatedDate(Date value)
      Setter for createdDate The UTC timestamp of the time when this notification was created.

    • getModifiedUserId

      public Integer getModifiedUserId()
      Getter for modifiedUserId The unique ID number of the user who most recently modified this notification.

    • setModifiedUserId

      public void setModifiedUserId(Integer value)
      Setter for modifiedUserId The unique ID number of the user who most recently modified this notification.

    • getModifiedDate

      public Date getModifiedDate()
      Getter for modifiedDate The UTC timestamp of the time when this notification was last modified.

    • setModifiedDate

      public void setModifiedDate(Date value)
      Setter for modifiedDate The UTC timestamp of the time when this notification was last modified.

    • toString

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