For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Sign in Book a demo

Home Guides API Reference Glossary

Home Guides API Reference Glossary

API Reference
- - GETSearch entities
  - POSTCreate entity
  - GETGet entity
  - POSTUpdate entity
  - DELDelete entity
  - POSTAccept Terms of Service
  - POSTInitiate KYB
  - POSTGenerate JWT Token
  - GETGenerate Onboarding Link
  - POSTSend Onboarding Email
  - GETEvents
  - GETGet All
    GETGet
    POSTUpdate

Sign in Book a demo

API Reference Entity Notification Policy

Get All

GET

https://api.mercoa.com/entity/:entityId/notification-policies

GET

/entity/:entityId/notification-policies

$ curl https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/notification-policies \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "disabled": false,
4     "additionalRoles": [
5       "admin",
6       "approver"
7     ],
8     "additionalUsers": [
9       "user_1234"
10     ],
11     "notifyPayeeCounterparty": true,
12     "notifyPayorCounterparty": true,
13     "type": "INVOICE_APPROVAL_NEEDED"
14   },
15   {
16     "disabled": false,
17     "additionalRoles": [
18       "admin",
19       "bookkeeper"
20     ],
21     "additionalUsers": [],
22     "notifyPayeeCounterparty": false,
23     "notifyPayorCounterparty": true,
24     "type": "INVOICE_APPROVED"
25   }
26 ]

Retrieve all notification policies associated with this entity

Was this page helpful?

Get

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Response

This endpoint returns a list of objects.

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented