v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Customer Invoices

Send a customer invoice by email

This endpoint allows you to send a finalized, imported customer invoice or credit note by email to your customer. This requires that the PDF file for that document has been generated (this process can take a few minutes), so if you just created the invoice in our system, we may return a 409 error. You should retry the request in a few minutes - if you receive a 204 response, that means that the email is on its way. For more information about email sending, please read this guide.

ℹ️ This endpoint requires the following scope: customer_invoices:all

post/api/external/v2/customer_invoices/{id}/send_by_email

Path parameters

idinteger required

The unique identifier of the customer invoice

Request body

recipientsstring[]

Email recipients.

If empty, the email will be sent to the recipient email addresses specified for the customer of this invoice.

Response

Invoice is being sent by email