Skip to content

Send by email

This guide describes how to send a document (invoice or credit note) by email from xTool.

Prerequisites

  • Document created or uploaded in xTool. See Create documents.
  • Recipient email address — you will specify it when sending (web or API).

Web

  1. Open the document in the Documents list.
  2. Click Send Document by Email.
  3. Enter the Receiver Email.
  4. If your organisation has email templates, choose an Email Template (the Default template is pre-selected). Otherwise choose the language for the standard message.
  5. Choose whether to Attach Original Document and/or Attach PDF visualisation. At least one attachment is required.
  6. Click Send.

To create or change the message text, subject, CC, or BCC, use Email templates. To send from your own mail server and From address, configure Custom SMTP.

API

Send a POST request to the document send endpoint:

  • Endpoint: POST /api/v2/documents/{document_id}/send (or equivalent).
  • Body: e.g. {"transaction_type": "send.email", "email": "recipient@example.com", "lang": "en"}. Optional: lang (language of the standard message), template_id (an email template created in the web app), attach_original_document, attach_pdf_visualisation.

The response confirms the send; the document may get a status update (e.g. sent).

See API reference for the exact endpoint and parameters.

Next steps