Invoicing

Send an invoice (post to books, optionally email)

Posts the invoice issue journal idempotently, then optionally emails the customer. API-key external email delivery requires confirmed=true; a short-lived previewToken from /invoices/{id}/preview is optional for direct sends and, when supplied, binds the exact recipient/options/email/PDF that are delivered. Session/mobile callers retain the legacy email body. An email failure never rolls back the posting: the response reports emailDelivered=false with emailError, and resending replays the posting as a no-op. Pass Idempotency-Key so a retried request cannot email the customer twice.

post/invoices/{id}/send

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/invoices/{id}/send
  • 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

Headers

Idempotency-Keystring

Stable retry key for this posting request within the LedgerHQ organization.

Request body

sendEmailtrue
confirmedtrue

Required for API-key external email delivery; previewToken remains optional for a direct confirmed send.

recipientEmailstring email
subjectstring
attachPdfboolean
includePaymentLinkboolean
previewTokenstring

Optional signed invoice preview token. When supplied, it must match the recipient, subject, message, attachment, payment-link choice, invoice, contact, branding, template, and PDF that are being sent.

confirmationTokenstring

Deprecated alias for previewToken.

personalMessagestring

Response

Posted invoice with email delivery status

Changes

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