entity > user > notifications

Get All

get/entity/{entityId}/user/{userId}/notifications

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/user/{userId}/notifications
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

userIdstring required

User ID or User ForeignID

Query parameters

startDatestring date-time

Start date for notification created on date filter.

endDatestring date-time

End date for notification created date filter.

orderDirection'ASC' | 'DESC'

Direction to order notifications by. Defaults to asc.

limitinteger

Number of invoices to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstring

The ID of the notification to start after. If not provided, the first page of invoices will be returned.

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

The type of notification to filter by.

status'PENDING' | 'SENT' | 'READ' | 'FAILED'

The status of the notification to filter by.

Response

Response with status 200

countinteger required

Total number of notifications for the given start and end date filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMoreboolean required

True if there are more notifications available for the given start and end date filters.

Changes

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