Invoices

Preview a payment reminder email

Renders the HTML, subject, and resolved recipients of the reminder email without sending it. Same override fields as send-reminder.

post/companies/{company}/invoices/{invoice}/reminder-preview

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/invoices/{invoice}/reminder-preview
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

invoicestring uuid required

Public identifier (UUID v7) of the invoice.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

emailstring email nullable

Recipient other than the client email.

subjectstring nullable

Custom subject for the reminder.

messagestring nullable

Additional message for the reminder body.

ccstring[] nullable

Carbon copy addresses.

bccstring[] nullable

Blind carbon copy addresses.

attach_pdfboolean nullable

Per-send override for "attach the invoice PDF". If omitted (or null), the company default (email_settings) is used.

stripe_payment_buttonboolean nullable

Per-send override for the "Stripe payment button". If omitted (or null), the company default is used.

Response

Example response

{
  "data": {
    "subject": "Recordatorio de pago: Factura F-2026-015",
    "html": "<!DOCTYPE html><html lang=\"es\"><head>...</head><body>... Recordatorio de pago. Factura F-2026-015 ... Importe total 1.802,90 € ... Fecha de vencimiento 03/05/2026 ...</body></html>",
    "from": "customer@example.com",
    "from_name": "Factuarea",
    "to": "contacto@cliente.example",
    "cc": [
      "copia@cliente.example"
    ],
    "bcc": [
      "registro@cliente.example"
    ],
    "status": "overdue",
    "invoice_number": "F-2026-015",
    "total": "1802.90",
    "due_date": "2026-05-03",
    "public_url": "https://app.factuarea.com/d/feb47de0-d6ed-40de-a4d4-8825182f5a6d",
    "public_link_active": true,
    "public_link_expires_at": "2026-07-02T17:46:46+02:00"
  }
}

Changes

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