Skip to navigation

Send paid notification

View as Markdown

Send paid-invoice notification

Manually (re)sends the paid-invoice email/receipt for the invoice :id to the supplied list of email addresses.

Auth

x-api-key header with Merchant.invoice.patch. Also accepts JWT user and POS JWT.

Path params

  • id (required): the invoice id.

Body

InvoiceNotificationDto (JSON): emails — a non-empty array of valid email addresses.

Side effects

Sends an email per recipient and records an EMAIL_NOTIFICATION_SENT invoice event.


Notas: Delegates to ManualInvoiceNotifierService.sendPaidInvoice(id, emails). Only the emails array is consumed from the body.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the paid invoice to notify about.

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.

Request

This endpoint expects an object.
emailslist of stringsRequired