Sign in
Invoices

Send Invoice record

Send an existing invoice by email, with the invoice PDF attached.

The path {record_number} is the invoice number.

The body matches POST /api/email_send/invoice/ (to_emails, cc_emails, bcc_emails, pdf_content, subject, message, sandbox). pdf_content is optional. If it is omitted or empty, the worker captures the invoice PDF. If subject or message is omitted or empty, company invoice email templates are used, then organization defaults.

If to_emails is omitted or empty, the customer email on the invoice is used.

A 200 response means the send was accepted, not that the provider has delivered the message. Emails are sent in the background

post/public/v1/invoices/{record_number}/send/

Path parameters

record_numberinteger required

The number attribute of the record.

The number attribute of the record.

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

to_emailsstring[]
cc_emailsstring[]
bcc_emailsstring[]
pdf_contentstring nullable
messagestring nullable
subjectstring nullable
sandboxboolean nullable
invoice_idinteger nullable

Response

OK

successtrue
errorsobject

Changes

Changed in 1 of the 27 revisions of this API.1

Of the 27 revisions, 1 has no diff computed.