Retrieve the report of a closed period
Return the monthly report of a closed period by the close id (UUID v7), read from the frozen snapshot without recomputation, so the totals never drift from the sheet at the moment of closing. It holds the company aggregate totals and one row per employee with totals, absence breakdown and balances, and the daily detail. Totals are in minutes. A period without a close returns 404. A computed resource: it exposes close_id, never an id of its own.
In: header
Path Parameters
Header Parameters
Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.
dateOperate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.
uuidResponse Body
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"
}
}