Send a receivable via email | Monite Documentation

Sends an email containing the specified invoice, quote, or credit note and its attachments to the specified receipients. For more information, see Send an invoice via email.

You can only send receivables that have the following statuses:

Invoices: draft, issued, partially_paid, paid, overdue. In the non-compliant mode: also canceled.
Quotes: draft, issued.
Credit notes: draft, issued.

Draft receivables are automatically moved to the issued status before being emailed. That is, you can use /receivables/{receivable_id}/send as a shortcut for /receivables/{receivable_id}/issue + /send, if needed. If issuing fails, the receivables remains in the draft status and no email is sent.

The counterpart’s default email address, which is stored in the counterpart_contact.email field of the receivable, is automatically added to the recipients.to list.

The response contains the mail_id which you can pass to GET /receivables/{receivable_id}/mails/{mail_id} to check the email sending status.

If you use custom email templates, note that Monite has separate template types for unpaid invoices, fully paid invoices, quotes, and credit notes.

Sends an email containing the specified invoice, quote, or credit note and its [attachments](https://docs.monite.com/accounts-receivable/customization/attachments) to the specified receipients. For more information, see [Send an invoice via email](https://docs.monite.com/accounts-receivable/invoices/create#send-via-email). You can only send receivables that have the following statuses: * Invoices: `draft`, `issued`, `partially_paid`, `paid`, `overdue`. In the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance): also `canceled`. * Quotes: `draft`, `issued`. * Credit notes: `draft`, `issued`. Draft receivables are automatically moved to the `issued` status before being emailed. That is, you can use `/receivables/{receivable_id}/send` as a shortcut for `/receivables/{receivable_id}/issue` + `/send`, if needed. If issuing fails, the receivables remains in the `draft` status and no email is sent. The counterpart's default email address, which is stored in the `counterpart_contact.email` field of the receivable, is automatically added to the `recipients.to` list. The response contains the `mail_id` which you can pass to [`GET /receivables/{receivable_id}/mails/{mail_id}`](https://docs.monite.com/api/receivables/get-receivables-id-mails-id) to check the email sending status. If you use [custom email templates](https://docs.monite.com/advanced/email-templates/index), note that Monite has separate template types for unpaid invoices, fully paid invoices, quotes, and credit notes.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

receivable_idstringRequired

ID of an existing invoice, quote, or credit note that you want to send via email.

Headers

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

body_textstringRequired>=1 character

A plain-text string to be inserted into the email body. Use new line characters \n to split the text into paragraphs.

This text substitutes the {{body_template}} variable in the email template used, whereas the template itself defines the HTML layout, styles, and formatting of the email body. In the default email templates, this text goes after the logo and heading but before the receivable’s details.

This text can include variables as placeholders for document-specific and counterpart-specific data.

A plain-text string to be inserted into the email body. Use new line characters `\n` to split the text into paragraphs. This text substitutes the `{{body_template}}` variable in the [email template](https://docs.monite.com/advanced/email-templates/index) used, whereas the template itself defines the HTML layout, styles, and formatting of the email body. In the default email templates, this text goes after the logo and heading but before the receivable's details. This text can include [variables](https://docs.monite.com/advanced/variables) as placeholders for document-specific and counterpart-specific data.

subject_textstringRequired>=1 character

Email subject text. Can include variables.

recipientsobjectOptional

Additional email recipients besides the counterpart’s default contact (which is stored in the counterpart_contact.email field of the receivable).

Response

Successful Response

mail_idstringformat: "uuid"

A unique ID of the email sending operation triggered by this API call. You can pass this value to GET /receivables/{receivable_id}/mails/{mail_id} to check the email sending status.

Errors