Send document email
Sends a supported public document by email.
Supported document types
The endpoint supports invoice, proforma, order, credit-note, and quotation.
Business behavior
- The target document is resolved via
documentType+documentIdand must be available in the token scope. - The
tofield accepts an array of one or more email addresses. - The
typefield is required for a uniform contract. Forinvoiceandproforma, it changes the subject and mail type (regular,reminder,overdue_reminder,confirmation). Fororder,credit-note, andquotation, it currently behaves the same as a regular send. - The endpoint does not return a response body; success is indicated by
202 Accepted.
If you send an Idempotency-Key, the same key with the same payload returns the original response without sending the email again.
Authorizations
Headers
Body
Payload used to send a supported document by email. The target document is selected through documentType + documentId and must be available in the token scope.
Optional custom text inserted into the email body. Supports {{document_number}} (document number), {{customer_name}} (customer), {{company_name}} (issuer), {{issue_date}} (issue date), {{due_date}} (due date), {{total}} (total including VAT), {{amount_due}} (remaining amount due), {{variable_symbol}} (variable symbol), {{iban}} (document bank account IBAN), {{total_without_vat}} (total excluding VAT), {{delivery_date}} (delivery date), {{constant_symbol}} (constant symbol), and {{specific_symbol}} (specific symbol). Delivery date is available for invoices and credit notes; payment symbols for invoices, proformas, and credit notes. Tags are replaced with the document's data before the email is persisted and queued for delivery. Dates follow the document's language; amounts follow its language and currency, with two decimal places. Data unavailable for the document is replaced with an empty string. Unknown tags remain unchanged. Omitting this field or passing null does not automatically use the saved template from settings. Input text must not contain URLs and is limited to 1000 characters before tag replacement.
1000"Please find document {{document_number}} attached, totalling {{total}}."
Response
Document send request accepted.

