Preview a receivable's email message

You can preview emails only for documents in the following statuses:

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

You can preview emails only for documents in the following statuses: * Invoices: `draft`, `issued`, `overdue`, `partially_paid`, `paid`. In the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance): also `canceled`. * Quotes: `draft`, `issued`. * Credit notes: `draft`, `issued`.

Path parameters

receivable_idstringRequired

ID of an existing invoice, quote, or credit note.

Headers

AuthorizationstringRequired

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

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

Body text of the content

subject_textstringRequired>=1 character

Subject text of the content

languageenumOptional

Language code for localization purposes

typeenumOptional

The type of the preview document.

Allowed values:

Response

Successful Response

body_previewstring

subject_previewstring

1	curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/preview \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"body_text": "body_text",
8	"subject_text": "subject_text"
9	}'

Path parameters

Headers

Request

Response

Errors