API ReferenceEntityNotification Policy

Get

Retrieve notification policy associated with this entity

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

notificationTypeenumRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
disabledboolean

True if the selected notification type is disabled for this entity

additionalRoleslist of strings

List of user roles that should receive notifications in addition to the default users for this notification type

additionalUserslist of strings

List of user IDs that should receive notifications in addition to the default users for this notification type

notifyPayeeCounterpartyboolean

True if the selected notification type should be sent to the counterparty if this is a payable invoice.

notifyPayorCounterpartyboolean

True if the selected notification type should be sent to the counterparty if this is a receivable invoice.

typeenum

Errors