Obtenir el resum consolidat de compliment de plantilla
Retorna el panell consolidat de compliment del control horari de tota la teva cartera gestionada: una fila per empresa gestionada active, cadascuna projectada des del darrer tancament mensual d'aquesta empresa sense recomputar — si el període actual (el darrer tancable) està tancat, el seu estat (closed/reopened), el darrer període tancat (last_closed_year/last_closed_month), i els agregats total_balance_minutes, total_overtime_minutes i employee_count. D'àmbit master: la cartera es resol des de la teva API key, mai des del payload, i només apareixen les teves pròpies empreses filles. A diferència dels endpoints per empresa amb X-Active-Profile, aquest agrega entre empreses filles en una sola crida. Es retorna com a { "data": [ConsolidatedWorkforce, ...] }.
A: header
Paràmetres de capçalera
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.
dateOpera 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.
uuidCos de la resposta
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.gestoria.workforceSummary();{
"data": [
{
"id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a02",
"name": "Distribuciones Ibéricas, S.L.",
"tax_id": "B87654321",
"current_period_closed": true,
"current_period_status": "closed",
"last_closed_year": 2026,
"last_closed_month": 4,
"total_balance_minutes": 1200,
"total_overtime_minutes": 540,
"employee_count": 12
}
]
}{
"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": "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"
}
}