Send invoice, quote, or reminder by email
Changed onSends an invoice/quote/reminder email and records a send log in sentEmailHistory.
Use invoiceStatus to control how the email is sent and logged:
- invoice (default) — standard invoice email
- quote or offer — quote/offer email
- reminder — payment reminder email
- confirmation — payment confirmation email
Alternatively, use overrides to set the invoice type or payment status for the email template.
Request
- Base URLhttps://api.vocal.email/v1
- Auth
- API key in header X-API-Key
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Sent (or send attempted)
Changes
- breaking
request property
was restricted to a list of enum values - breaking
the
/request property's minLength was increased from0to1 - breaking
the
/request property format changed from no format toemail - breaking
the
request property type changed fromstringtostringnull, and format from no format toemail - breaking
the
request property type changed fromstringtostringnull, and format from no format toemail - warning
the
/request property's maxLength was set to254 - warning
the
request property's maxLength was set to254 - warning
the
request property's maxLength was set to254 - info
added the new optional request property
/ - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became optional - info
the
request property default valuefalsewas removed - info
added the new
advancePaymentenum value to the request property - info
added the new
deenum value to the request property - info
added the new
deliveryBillenum value to the request property - info
added the new
enenum value to the request property - info
added the new
frenum value to the request property - info
added the new
itenum value to the request property - info
added the new
orderConfirmationenum value to the request property - info
added the new
undefinedenum value to the request property - info
added the new
undefinedenum value to the request property
- breaking