Invoicing

Preview exact invoice email and PDF delivery

Renders the exact canonical email and branded PDF without posting, sending, changing invoice status, or persisting a payment link. When includePaymentLink=true, the preview contains a signed candidate link that is persisted only by the confirmed send. API-key callers can pass the returned previewToken for exact delivery confirmation, or use a direct send with confirmed=true when a preview is not needed.

post/invoices/{id}/preview

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/invoices/{id}/preview
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

idstring uuid required

Invoice UUID

Request body

recipientEmailstring email

Defaults to the customer contact email

subjectstring

Defaults to the canonical invoice subject

personalMessagestring
attachPdfboolean
includePaymentLinkboolean

Shows a signed candidate payment link and persists it only when the confirmed send runs

Response

Exact email HTML/text, PDF base64 bytes, and a short-lived preview token. Invoice amounts are integer cents.

Changes

No recorded changes to this operation across all 5 revisions of this API.