Send a notification email to a vendor or customer. Uses predefined templates for common events or a custom message.

post/api/v1/notification-send

Request

  • Base URL: https://app.ledgerbeaver.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.ledgerbeaver.com/api/v1/notification-send
  • Auth: API key in header X-API-Key

Request body

companyIdstring required
recipientTypestring required
recipientIdstring required
triggerEventstring required
templateDatastring required
invoiceNumberstring required
amountnumber required
dueDatestring required
paymentMethodstring required
scheduledDatestring required
referenceNumberstring required
portalUrlstring required
customSubjectstring required
customBodystring required

Response

Successful response

Changes

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