Vista prèvia d'un email de recordatori de pagament

Renderitza l'HTML, l'assumpte i els destinataris resolts de l'email de recordatori sense enviar-lo.

Mateixos camps d'override que send-reminder.

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

email?|

Destinatari diferent de l'email del client.

Formatemail

subject?|

Assumpte personalitzat per al recordatori.

Longitudlength <= 200

message?|

Missatge addicional per al cos del recordatori.

Longitudlength <= 5000

cc?array<>|

Adreces en còpia.

bcc?array<>|

Adreces en còpia oculta.

attach_pdf?|

Override per enviament per a "adjuntar el PDF de la factura". Si s'omet (o és null), es fa servir el valor per defecte de l'empresa (email_settings).

stripe_payment_button?|

Override per enviament per al "botó de pagament de Stripe". Si s'omet (o és null), es fa servir el valor per defecte de l'empresa.

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/invoices/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/reminder-preview", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json"} },  body: JSON.stringify({  "email": "contacto@cliente.example",  "subject": "Recordatorio de pago: Factura F-2026-015",  "message": "Le recordamos que la factura F-2026-015 se encuentra pendiente de pago.",  "cc": [    "copia@cliente.example"  ],  "bcc": [    "registro@cliente.example"  ]}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "subject": "Recordatorio de pago - Factura FAC-2026-00042",
    "html": "<p>Estimado cliente, le recordamos que la factura <strong>FAC-2026-00042</strong> por importe de 1210,00 € venció el 14/04/2026 y está pendiente de pago.</p>",
    "from": "facturacion@tuempresa.com",
    "from_name": "Tu Empresa SL",
    "to": "cliente@acme.es",
    "cc": [],
    "bcc": [],
    "status": "overdue",
    "invoice_number": "FAC-2026-00042",
    "total": 1210,
    "due_date": "2026-04-14",
    "public_url": "https://app.factuarea.com/d/9f3c1a7e-2b8d-4c6f-9e1a-7d5b3c2e8f04",
    "public_link_active": true,
    "public_link_expires_at": "2026-09-15T23:59:59Z",
    "reminders_sent": 1,
    "last_reminder_sent_at": "2026-04-20T09:00:00Z",
    "cooldown_active": false
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_4f2a9a744b2359df4e60269cab"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'invoices:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_493726fbf0f48b5984c4be086f"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "invoice_not_found",
    "message": "Factura no encontrada.",
    "param": "invoice_uuid",
    "subcode": "invoice_not_found",
    "doc_url": "https://docs.factuarea.com/guides/errors#invoice_not_found",
    "request_id": "req_4fe262928e419a7e1536e7f245"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo email no tiene un valor válido.",
    "param": "email",
    "errors": [
      {
        "param": "email",
        "code": "parameter_invalid_value",
        "message": "El campo email no tiene un valor válido."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_357cee7981b21779534bb4442e"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_f58a9ab31329a89d6988e0ffad"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_8efbecbf3d1f722113eb9fb1ab"
  }
}

Vista prèvia d'un email de recordatori de pagament

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Vista prèvia d'un email de recordatori de pagament

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`