Obtener el informe de un periodo cerrado
Devuelve el informe mensual de un periodo cerrado por el id (UUID v7) del cierre, leído de la instantánea congelada sin recomputar, así que los totales nunca divergen de la hoja en el momento del cierre. Contiene los totales agregados de la empresa y una fila por empleado con totales, desglose de ausencias y saldos, y el detalle diario. Los totales están en minutos. Un periodo sin cierre devuelve 404. Un recurso computado: expone close_id, nunca un id propio.
En: header
Parámetros de ruta
Parámetros de cabecera
Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.
dateOpera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.
uuidCuerpo de la respuesta
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.monthlyTimeRecordCloses.report("01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01");{
"data": {
"object": "monthly_close_report",
"close_id": "01933a40-04a9-73b5-9bc2-9c0d1e2f3a01",
"year": 2026,
"month": 4,
"status": "closed",
"total_expected_minutes": 115200,
"total_worked_minutes": 116400,
"total_balance_minutes": 1200,
"total_overtime_minutes": 540,
"employees": [
{
"employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
"employee_name": "Lucía Fernández Ruiz",
"total_expected_minutes": 9600,
"total_worked_minutes": 9720,
"total_balance_minutes": 120,
"total_overtime_minutes": 90,
"approved_absence_days": "2.00",
"absence_breakdown": [
{
"absence_type_name": "Vacaciones",
"days_taken": "2.00"
}
],
"absence_balances": [
{
"absence_type_name": "Vacaciones",
"available_days": "18.50"
}
],
"days": [
{
"date": "2026-05-04",
"expected_minutes": 480,
"worked_minutes": 510,
"balance_minutes": 30,
"overtime_minutes": 15,
"is_holiday": false,
"is_approved_absence": false,
"is_rest_day": 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": "not_found_error",
"code": "resource_not_found",
"message": "El recurso solicitado no existe o pertenece a otra empresa.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
"request_id": "req_01HKQS5NEQ6X1R4N9B0C5DWTPG"
}
}{
"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"
}
}