Factuarea API
Enviaments d'email

Resumeix el lliurament d'email per document

Respon a «ha sortit l'email d'aquests documents?» per a un lot sencer de cop, en lloc de paginar els enviaments de cadascun: per document, quants emails s'han enviat, l'últim estat, l'últim lliurament al servidor SMTP i quants han fallat. Ideal per pintar una columna «enviat / no enviat» sobre una pàgina de factures en una sola crida.

IMPORTANT — last_status i last_sent_at descriuen el lliurament al SERVIDOR SMTP DE SORTIDA, no el lliurament real: un email sent pot rebotar després sense que la plataforma se n'assabenti.

GET
/emails/indicators
AuthorizationBearer <token>

A: header

Paràmetres de consulta

related_entity_ids[]*array<>

Documents a resumir: UUID v7 de cadascun, separats per comes (related_entity_ids=a,b,c) o repetits. Obligatori, màxim 100 per crida — més retorna 422. El tipus no cal: un UUID v7 és únic a escala global, així que el lot POT barrejar factures, pressupostos, factures proforma, albarans, factures de compra i factures recurrents. Els ids sense cap email, i els que no pertanyen a un document de la teva empresa, s'OMETEN de la resposta en lloc d'informar-se a zero, així que fes coincidir els resultats per related_entity_id.

Formatuuid
related_entity_type?string

Tipus de document opcional que acota la resolució de tots els ids del lot.

Valor a"invoice" | "quote" | "proforma" | "delivery_note" | "purchase_invoice" | "recurring_invoice"

Paràmetres de capçalera

Factuarea-Version?string

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 resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

import { Factuarea } from "@factuarea/sdk";const factuarea = new Factuarea({ apiKey: process.env.FACTUAREA_API_KEY! });const result = await factuarea.emails.indicators();
{
  "data": [
    {
      "related_entity_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a9c",
      "related_entity_type": "invoice",
      "object": "email_delivery_indicator",
      "total": 2,
      "last_status": "sent",
      "last_sent_at": "2026-07-15T09:30:12+00:00",
      "attempts": 1,
      "failed_count": 0
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "message": "El parámetro 'per_page' no está reconocido por este endpoint.",
    "param": "per_page",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZ9"
  }
}

{
  "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"
  }
}