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.

⚠️

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique identifier of the customer invoice

Body Params
recipients
array of strings

Email recipients.

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

recipients
int64

Billing email template to use for this send.

It must belong to the company and have kind billing_email_invoice.
Its locale does not have to match the customer's billing language.
Subject, body, cc and bcc then come from that template.

Not supported for an invoice collected by GoCardless. That invoice
keeps the GoCardless billing email template.

When omitted, the company's default template for the customer's billing language is used.
In that case only the subject and body are applied.

Headers
string

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.

Responses
204

Invoice is being sent by email

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json