Obtenir l'informe d'un període tancat

Retorna l'informe mensual d'un període tancat pel id (UUID v7) del tancament, llegit de la instantània congelada sense recomputar, així que els totals mai divergeixen del full en el moment del tancament.

Conté els totals agregats de l'empresa i una fila per empleat amb totals, desglossament d'absències i saldos, i el detall diari.
Els totals estan en minuts.
Un període sense tancament retorna 404. Un recurs computat: exposa close_id, mai un id propi.

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

monthly_time_record_close*string

Headers

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`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/monthly-time-record-closes/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/report", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "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": "19.00"
          }
        ],
        "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": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_ae3b95eca057657cc7821a68bd"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'time_entries:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_d9b929aa948f6f4f2e20da8c5b"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "No existe ningún cierre del registro de jornada con el identificador '01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8aff'.",
    "subcode": "monthly_time_record_close_not_found",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_c9fc4cc47d830599d378db2313"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_79f3e762e1ca58e9b9c88e1afe"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_03e7e1b6a40438d2df3bd0eb1c"
  }
}

Obtenir l'informe d'un període tancat

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

200application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`