Retrieve an employee’s time balance for a period

Return the time balance of an arbitrary period of an employee: expected vs worked minutes, the balance and overtime per day, and the period totals.

The employee is the {employee} (UUID v7) in the path; from and to (YYYY-MM-DD) are required.
This is the same contract the monthly close reuses over closed periods.
A range where to is before from returns 422. Totals are in minutes.
A computed resource: it exposes employee_id, never an id.

Query Parameters

from*string

Period start date (YYYY-MM-DD).

Formatdate

to*string

Period end date (YYYY-MM-DD).

Formatdate

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.

Formatdate

X-Active-Profile?string

Operate 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.

Formatuuid

Response Body

`application/json`

Request example

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/time-balances/employee/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01?from=2026-03-15&to=2026-03-15", {  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());

Response example

{
  "data": {
    "object": "time_balance",
    "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "from": "2026-05-01",
    "to": "2026-05-31",
    "total_expected_minutes": 9600,
    "total_worked_minutes": 9720,
    "total_balance_minutes": 120,
    "total_overtime_minutes": 90,
    "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_c355343e5b694767850e9e4b60"
  }
}

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

{
  "error": {
    "type": "not_found_error",
    "code": "employee_not_found",
    "message": "Empleado no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#employee_not_found",
    "request_id": "req_822a963c68b59c1fc2027d53fb"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo from no tiene un valor válido.",
    "param": "from",
    "errors": [
      {
        "param": "from",
        "code": "parameter_invalid_value",
        "message": "El campo from no tiene un valor válido."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_d0703456b6342a2f2a9c9c485c"
  }
}

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

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

Retrieve an employee’s time balance for a period

Authorization

Path Parameters

Query Parameters

Headers

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve an employee’s time balance for a period

Authorization

Path Parameters

Query Parameters

Headers

Response Body

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`