entity > notification-policy

Get All

Retrieve all notification policies associated with this entity

get/entity/{entityId}/notification-policies

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/notification-policies
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Response

Response with status 200

disabledboolean required

True if the selected notification type is disabled for this entity

additionalRolesstring[] required

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

additionalUsersEntityTypesEntityUserId[] required

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

notifyPayeeCounterpartyboolean required

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

notifyPayorCounterpartyboolean required

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

type'INVOICE_APPROVAL_NEEDED' | 'INVOICE_APPROVED' | 'INVOICE_REJECTED' | 'INVOICE_SCHEDULED' | 'INVOICE_PENDING' | 'INVOICE_PAID' | 'INVOICE_CANCELED' | 'INVOICE_CREATED' | 'INVOICE_EMAILED' | 'INVOICE_FAILED' | 'COUNTERPARTY_ONBOARDING_COMPLETED' required

Changes

No recorded changes to this operation across all 1 revision of this API.