Preview invoice email

const options = {method: 'GET'};

fetch('https://api.dolfinai.co/invoices/{id}/email-preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "subject": "<string>",
  "previewText": "<string>",
  "greetingLine": "<string>",
  "openingBodyMarkdown": "<string>",
  "openingBodyHtml": "<string>",
  "htmlBody": "<string>",
  "textBody": "<string>"
}

Invoices

Preview invoice email

Returns the rendered email that will be sent for this invoice. Only available while the invoice is in Draft status. Optional ?tone= and ?industryGroup= query parameters let callers rehearse a different catalogue cell without changing the organisation’s defaults; when omitted, the organisation’s DefaultInvoiceMessageTone and its industry group are used. Optional ?subject=, ?previewText=, ?greetingLine= and ?openingBodyMarkdown= mirror the SendInvoiceOverrides fields so the caller can preview the exact email that would be sent with those overrides.

GET

invoices

{id}

email-preview

Preview invoice email

const options = {method: 'GET'};

fetch('https://api.dolfinai.co/invoices/{id}/email-preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "subject": "<string>",
  "previewText": "<string>",
  "greetingLine": "<string>",
  "openingBodyMarkdown": "<string>",
  "openingBodyHtml": "<string>",
  "htmlBody": "<string>",
  "textBody": "<string>"
}

Path Parameters

string<uuid>

required

Query Parameters

tone

enum<string>

Available options:

Friendly,

Direct,

Formal

industryGroup

any

Available options:

Agriculture,

ContractedServices,

Transportation,

Utilities,

RetailStores,

Clothing,

MiscellaneousRetail,

FinancialServices,

PersonalServices,

BusinessServices,

ProfessionalServices,

Government,

Entertainment,

Travel,

null

subject

string

previewText

string

greetingLine

string

openingBodyMarkdown

string

Response

subject

string

required

previewText

string

required

greetingLine

string

required

openingBodyMarkdown

string

required

openingBodyHtml

string

required

htmlBody

string

required

textBody

string

required

Void invoice

List invoice emails