Factuarea API
Facturas

Vista previa de un email de recordatorio de pago

Renderiza el HTML, el asunto y los destinatarios resueltos del email de recordatorio sin enviarlo. Mismos campos de override que send-reminder.

POST
/invoices/{invoice}/reminder-preview

Authorization

AuthorizationBearer <token>

En: header

Parámetros de ruta

invoice*string

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

{
  "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": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}

Enviar por email el ZIP trimestral al asesor

Genera el ZIP trimestral y lo envía por email al destinatario, normalmente el asesor fiscal.

Envía un recordatorio de pago

Envía por email un recordatorio de pago al cliente para esta factura. Acepta valores opcionales `email`, `subject`, `message`, `cc`, `bcc` para sobrescribir.