Models
Email delivery options. When a Peppol recipient is provided, email is optional and you can choose to always send the email, or only when Peppol delivery fails, whether that is refused at send time or reported later by the access point. When the Peppol recipient is null, email becomes the primary delivery method and email.to is required. Each email counts towards your document quota at the moment it is sent.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
when | always | on_peppol_failure | No | When to send the email. always sends it with the Peppol transmission. on_peppol_failure sends it when the Peppol transmission is refused at send time, or when the access point reports afterwards that it failed; in that second case the email goes out at that moment and appears as email deliveries on the document, announced by a document.delivery_status_changed event. If the Peppol recipient is null, email is the only channel and is always sent. Default: on_peppol_failure. Values: always, on_peppol_failure |
to | string[] | Yes | The email addresses to send the document to. Example: ["support@recommand.eu"] |
subject | string | No | The subject of the email. If not provided, the subject will be autogenerated based on the document type. Example: "Invoice SI-001" |
htmlBody | string | No | The HTML body of the email. If not provided, the body will be autogenerated based on the document type. Example: "Dear customer, you can find your invoice attached." |
Used by
Delete Webhook DELETE
Stop delivering events to this endpoint and remove it.
PDFGeneration
Optionally generate a PDF of the document and include it as an embedded attachment (also included in email attachments when email sending is enabled). Not supported for message level responses, French Invoicing CDAR messages, or raw XML documents.