Module: AvaTax::Client::Notifications

Defined in:
lib/avatax/client/notifications.rb

Instance Method Summary collapse

Instance Method Details

#dismiss_notification(id) ⇒ Object

Mark a single notification as dismissed.

Marks the notification identified by this URL as dismissed.

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.

When you dismiss a notification, the notification will track the user and time when it was dismissed. You can then later review which employees of your company dismissed notifications to determine if they were resolved appropriately.

A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer) —

    The id of the notification you wish to mark as dismissed.

Returns:

  • (Object) 


29
30
 
# File 'lib/avatax/client/notifications.rb', line 29

def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
put(path, {}, AvaTax::VERSION)      end

#get_notification(id) ⇒ Object

Retrieve a single notification.

Retrieve a single notification by its unique ID number.

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.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer) —

    The id of the notification to retrieve.

Returns:

  • (Object) 


49
50
 
# File 'lib/avatax/client/notifications.rb', line 49

def get_notification(id)        path = "/api/v2/notifications/#{id}"
get(path, {}, AvaTax::VERSION)      end

#list_notifications(options = {}) ⇒ FetchResult

List all notifications.

List all notifications.

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.

You may search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST . Paginate your results using the $top, $skip, and $orderby parameters.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


75
76
 
# File 'lib/avatax/client/notifications.rb', line 75

def list_notifications(options={})        path = "/api/v2/notifications"
get(path, options, AvaTax::VERSION)      end