Skip to main content
POST
/
receivables
/
{receivable_id}
/
send
Send a receivable via email
curl --request POST \
  --url https://api.sandbox.monite.com/v1/receivables/{receivable_id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "body_text": "<string>",
  "subject_text": "<string>",
  "recipients": {
    "bcc": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "to": [
      "jsmith@example.com"
    ]
  }
}
'
{
  "mail_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
receivable_id
string<uuid>
required

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

Body

application/json

A schema for receiving a request for sending a receivable

​
body_text
string
required

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.

Minimum string length: 1
​
subject_text
string
required

Email subject text. Can include variables.

Minimum string length: 1
Example:

"New invoice #{invoice_number} from {entity_name}"

​
recipients
object

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

Response

Successful Response

A schema for returning a response an email with a link to receivable document has been sent

​
mail_id
string<uuid>
required

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.