Send a customer invoice by email
Changed onThis 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.
⚠️ Warning: If the invoice is eligible for electronic invoicing, sending it by email prevents it from later being transmitted through an approved platform (PA – Plateforme Agréée). For invoices within the scope of the e-invoicing reform, transmit them through the approved platform instead of sending them by email.
The subject and body come from the company's default billing email template for the customer's billing language, unless email_template_id is set. An invoice collected by GoCardless uses the GoCardless billing email template and does not accept email_template_id.
ℹ️ This endpoint requires the following scope: customer_invoices:all
Request
- Base URLhttps://app.pennylane.com
- URLhttps://app.pennylane.com/api/external/v2/customer_invoices/{id}/send_by_email
- AuthOAuth 2Authorization code: https://app.pennylane.com/oauth/authorizeToken URL: https://app.pennylane.com/oauth/oauth/token scopes: customer_invoices:all
Path parameters
The unique identifier of the customer invoice
Headers
Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.
Request body
Example request
{
"email_template_id": 42
}Response
Invoice is being sent by email
Changes
- info
added the new optional
headerrequest parameterX-Company-Id - info
added the new optional request property
- info