Skip to main content

Email Sales Invoice

POST 

/api/sales-invoices/:salesInvoice/email

Email the invoice PDF to the customer. to[] (1–20 email addresses, required), cc[] (optional), subject and message (optional — replace the template's), template_id (optional sales-invoice email template; defaults to the "Invoice Issued" template). Placeholders such as {invoice_number}, {amount_due}, {due_date}, {days_overdue} and {customer_name} are filled in. The send is logged on the customer's AR communications. Drafts and void invoices cannot be emailed.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires orders:write and sales_invoices.send.

Request​

Responses​

OK

Response Headers
    Content-Type