Invoices

Send invoice by email

Send the invoice to a recipient via email. If the invoice is in draft status, it will be automatically changed to sent.

post/v1/invoices/{invoiceId}/send

Request

  • Base URL: https://api.frihet.io
  • URL: https://api.frihet.io/v1/invoices/{invoiceId}/send
  • Auth: API key in header X-API-Key

Path parameters

invoiceIdstring required

Invoice unique identifier

Request body

recipientEmailstring email required

Recipient email address

recipientNamestring

Recipient name

customMessagestring

Optional custom message to include in the email

locale'es' | 'en'

Email language

Example request

{
  "recipientEmail": "client@example.com",
  "recipientName": "John Doe",
  "customMessage": "Please find attached your invoice."
}

Response

Invoice sent

successboolean
messageIdstring

Email provider message ID

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.