Email invoice
email_invoiceEmails the document to the client from Decknote on the user's behalf (replies go to the user), with a link to it; a draft takes the next number, becomes sent and its link is published. One plain address: the document's or to. Limited to 20 emails an hour per person and one email per document every 10 minutes. A new address beyond the plan's allowance (2 addresses in all on the free plan, 25 new ones a day on Pro) must first confirm that it wants the user's emails: it gets a link from Decknote and the call fails with code unconfirmed until it confirms. On the free plan the message cannot carry links or web addresses. Needs confirm: true and amount equal to the total; without them the result is a preview with the exact email.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Another address than the one on the document. | |
| amount | No | The document's total in the currency's main unit, repeated from the preview (e.g. 220 or "220.00"). Must equal the total or nothing is done. | |
| locale | No | ||
| confirm | No | true performs the action. Without it (or with any value other than the boolean true) nothing changes and the result is a preview of the effects. | |
| message | No | A few personal lines at the top, up to 2000 characters. | |
| reminder | No | A reminder for a sent invoice with a balance. | |
| invoiceId | Yes | The invoice or estimate. |