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

Class NotificationModel

java.lang.Object
net.avalara.avatax.rest.client.models.NotificationModel
public class NotificationModel
extends java.lang.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
    java.lang.Integer getAccountId()
    Getter for accountId The unique ID number of the account that received this notification.
    java.util.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.
    java.lang.String getActionLink()
    Getter for actionLink If there is a specific action suggested by this notification, this is the URL of the action.
    java.lang.String getActionName()
    Getter for actionName If there is a specific action suggested by this notification, this is the name of the action.
    java.lang.String getCategory()
    Getter for category The category of this notification.
    java.lang.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.
    java.util.Date getCreatedDate()
    Getter for createdDate The UTC timestamp of the time when this notification was created.
    java.lang.Integer getCreatedUserId()
    Getter for createdUserId The unique ID number of the user who created the notification.
    java.lang.Boolean getDismissed()
    Getter for dismissed When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API.
    java.lang.Integer getDismissedByUserId()
    Getter for dismissedByUserId If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification.
    java.util.Date getDismissedDate()
    Getter for dismissedDate If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification.
    java.util.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.
    java.lang.Long getId()
    Getter for id The unique id of the notification.
    java.lang.String getMessage()
    Getter for message The message for this notification.
    java.util.Date getModifiedDate()
    Getter for modifiedDate The UTC timestamp of the time when this notification was last modified.
    java.lang.Integer getModifiedUserId()
    Getter for modifiedUserId The unique ID number of the user who most recently modified this notification.
    java.lang.Boolean getNeedsAction()
    Getter for needsAction If this notification object requires user action to resolve, this value will be set to true.
    java.lang.Long getReferenceId()
    Getter for referenceId The unique reference Id number of the object referred to by this notification, if any.
    java.lang.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.
    java.lang.String getTopic()
    Getter for topic The topic of this notification.
    void setAccountId​(java.lang.Integer value)
    Setter for accountId The unique ID number of the account that received this notification.
    void setActionDueDate​(java.util.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​(java.lang.String value)
    Setter for actionLink If there is a specific action suggested by this notification, this is the URL of the action.
    void setActionName​(java.lang.String value)
    Setter for actionName If there is a specific action suggested by this notification, this is the name of the action.
    void setCategory​(java.lang.String value)
    Setter for category The category of this notification.
    void setCompanyId​(java.lang.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​(java.util.Date value)
    Setter for createdDate The UTC timestamp of the time when this notification was created.
    void setCreatedUserId​(java.lang.Integer value)
    Setter for createdUserId The unique ID number of the user who created the notification.
    void setDismissed​(java.lang.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​(java.lang.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​(java.util.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​(java.util.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​(java.lang.Long value)
    Setter for id The unique id of the notification.
    void setMessage​(java.lang.String value)
    Setter for message The message for this notification.
    void setModifiedDate​(java.util.Date value)
    Setter for modifiedDate The UTC timestamp of the time when this notification was last modified.
    void setModifiedUserId​(java.lang.Integer value)
    Setter for modifiedUserId The unique ID number of the user who most recently modified this notification.
    void setNeedsAction​(java.lang.Boolean value)
    Setter for needsAction If this notification object requires user action to resolve, this value will be set to true.
    void setReferenceId​(java.lang.Long value)
    Setter for referenceId The unique reference Id number of the object referred to by this notification, if any.
    void setReferenceObject​(java.lang.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​(java.lang.String value)
    Setter for topic The topic of this notification.
    java.lang.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

  • Method Details

    • getId

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

    • setId

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

    • getAccountId

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

    • setAccountId

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

    • getCompanyId

      public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.Boolean value)
      Setter for needsAction If this notification object requires user action to resolve, this value will be set to true.

    • getActionName

      public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.util.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​(java.util.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.util.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​(java.util.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 java.util.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​(java.util.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 java.lang.Integer getCreatedUserId()
      Getter for createdUserId The unique ID number of the user who created the notification.

    • setCreatedUserId

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

    • getCreatedDate

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

    • setCreatedDate

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

    • getModifiedUserId

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

    • setModifiedUserId

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

    • getModifiedDate

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

    • setModifiedDate

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

    • toString

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