Skip to main content
POST
Send document email

Authorizations

Authorization
string
header
required

Bearer token created for a specific company in Integrations → API.

Headers

Idempotency-Key
string

Optional request identifier for safe retries. Use a unique value for each create request you want to retry safely.

Example:

"invoice-create-2026-03-03-001"

Body

application/json

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.

documentType
enum<string>
required

Document type you want to send by email.

Available options:
invoice,
proforma,
order,
credit-note,
quotation
Example:

"invoice"

documentId
integer
required

ID of a supported document.

Example:

301

to
string<email>[]
required

Array of one or more target email addresses.

Minimum array length: 1
Example:
type
enum<string>
required

Mail type. For invoice and proforma, it changes the subject and template type; for order, credit-note, and quotation, it currently behaves the same as regular.

Available options:
regular,
reminder,
overdue_reminder,
confirmation
Example:

"reminder"

body
string | null

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.

Maximum string length: 1000
Example:

"Please find document {{document_number}} attached, totalling {{total}}."

Response

Document send request accepted.