React Library
Sign in
Book a demo
Search...
/
Home
Mercoa Overview
Getting Started
Step 1: API Keys and Concepts
Step 2: Backend Integration
Step 3: Frontend Integration
Payments Only Integration
Concepts
Invoices
Entities
Payment Methods
Custom Fields
Users
Approval Policies
Business Representative
Guides
Creating and Managing Payers
Creating and Managing Vendors
Email Inbox
Webhooks
Notifications
Bring Your Own Payments
Checks
Plaid Integration
Debit/Credit Card Capture
Accounting Sync
SDKs
React Component Library
Javascript (Node/Browser)
Python
Go
Java
.Net
API Reference
Entity Group
GET
Get All Groups
POST
Create Group
GET
Get Group
POST
Update Group
DEL
Delete Group
User
GET
Search Group Users
POST
Create Group User
GET
Get Group User
POST
Update Group User
DEL
Delete Group User
Invoice
GET
Get All
GET
Get Metrics
Entity
GET
Search entities
POST
Create entity
GET
Get entity
POST
Update entity
DEL
Delete entity
POST
Accept Terms of Service
POST
Initiate KYB
POST
Generate JWT Token
GET
Plaid Link token
GET
Generate Onboarding Link
POST
Send Onboarding Email
Email Log
GET
Get all incoming email logs
GET
Get incoming email log
User
GET
Get all entity users
PUT
Search entity users
POST
Create entity user
GET
Get entity user
POST
Update entity user
DEL
Delete entity user
POST
Generate JWT Token
Notification Policy
GET
Get All
GET
Get
POST
Update
Notifications
GET
Get All
GET
Get
PUT
Update
Approval Policy
GET
Get All
POST
Create
GET
Get
POST
Update
DEL
Delete
Counterparty
GET
Find payee counterparties
GET
Find payor counterparties
POST
Link Payees
POST
Hide Payee
POST
Link Payors
POST
Hide Payors
Customization
GET
Get
POST
Update
Document
GET
Get Documents
POST
Upload Document
DEL
Delete Document
External Accounting System
GET
Get External System
POST
Create/Update External Entity
GET
Connect External System
GET
Sync External System
Invoice
GET
Get All
GET
Get Metrics
Metadata
GET
Get All
GET
Get
POST
Update
DEL
Delete all metadata associated with a specific key
Notification Policy
GET
Get All
GET
Get
POST
Update
Payment Method
GET
Get All
POST
Create
GET
Get
PUT
Update
DEL
Delete
POST
Initiate micro deposits
PUT
Verify micro deposits
GET
Get available balance (deprecated)
Representative
GET
Get All
POST
Create
GET
Get
DEL
Delete
Invoice
GET
Search invoices
POST
Create
GET
Get
POST
Update
DEL
Delete
Line Item
PUT
Update invoice line item
Approval
POST
Add Approver
POST
Approve
POST
Reject
Comment
GET
Get All
POST
Create
GET
Get
POST
Update
DEL
Delete
Document
GET
Get Attachments
POST
Upload Attachment
DEL
Delete Attachment
GET
Get Invoice PDF
GET
Get Check PDF
GET
Get Source Email
Payment Links
GET
Get payment link
POST
Send payment email
GET
Get disbursement link
POST
Send disbursement email
Organization
GET
Get
POST
Update
GET
Email Log
Notification Configuration
GET
Get All
GET
Get
POST
Update
DEL
Reset
Bank Lookup
GET
Find bank
Calculate
POST
Calculate fees
POST
Calculate payment timing
Custom Payment Method Schema
GET
Get All
POST
Create
POST
Update
GET
Get
DEL
Delete
OCR
POST
Run OCR (Sync)
POST
Run OCR (Async)
GET
Get OCR Response (Async)
Payment Methods
GET
Find
Webhooks
POST
Counterparty Added
POST
Counterparty Hidden
POST
Entity Created
POST
Entity Updated
POST
Payment Method Created
POST
Payment Method Updated
POST
Payment Method Deleted
POST
Invoice Created
POST
Invoice Updated
POST
Invoice Deleted
POST
Invoice Status Changed
POST
Incoming Invoice Email
POST
Invoice Status Draft
POST
Invoice Status New
POST
Invoice Status Approved
POST
Invoice Status Refused
POST
Invoice Status Scheduled
POST
Invoice Status Pending
POST
Invoice Status Canceled
POST
Invoice Status Paid
POST
Invoice Status Failed
POST
Invoice Status Archived
React Library
Sign in
Book a demo
API Reference
Entity
Notification Policy
Get All
GET
https://
api.mercoa.com
/
entity
/
:entityId
/
notification-policies
Retrieve all notification policies associated with this entity
Path parameters
entityId
string
Required
Entity ID or Entity ForeignID
Response
This endpoint returns a list of objects
disabled
boolean
True if the selected notification type is disabled for this entity
additionalRoles
list of strings
List of user roles that should receive notifications in addition to the default users for this notification type
type
enum
Show 10 enum values
Built with