Retrieve an employee’s time balance for a period

Return an employee's time balance for a period: expected vs worked minutes, balance and overtime per day, and period totals (minutes). - from and to (YYYY-MM-DD) are required; to before from returns 422. - Days flagged is_unscheduled or is_outside_employment have expected, balance and overtime 0. Computed resource: exposes employee_id, no id.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid

employee*string

Public identifier (UUID v7) of the employee.

Formatuuid

Query Parameters

from*string

Period start date (YYYY-MM-DD).

Formatdate

to*string

Period end date (YYYY-MM-DD).

Formatdate

Headers

Factuarea-Version?string

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

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/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/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-01",
        "expected_minutes": 0,
        "worked_minutes": 0,
        "balance_minutes": 0,
        "overtime_minutes": 0,
        "is_holiday": true,
        "is_approved_absence": false,
        "is_rest_day": false,
        "is_unscheduled": false,
        "is_outside_employment": false
      },
      {
        "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,
        "is_unscheduled": false,
        "is_outside_employment": false
      }
    ]
  }
}

Retired X-Active-Profile header sent

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Malformed Factuarea-Version header

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Unsupported Factuarea-Version

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

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

GET /v1/companies/{company}/time-balances/employee/{employee} · 403 insufficient_scope

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

Company deactivated

{
  "error": {
    "type": "authorization_error",
    "code": "company_inactive",
    "message": "Esta empresa está desactivada. Actívala para operar.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#company_inactive",
    "request_id": "req_01J8Y3M2Q40000000000000005"
  }
}

GET /v1/companies/{company}/time-balances/employee/{employee} · 404 employee_not_found

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

Company not found or outside the API key scope

{
  "error": {
    "type": "not_found_error",
    "code": "profile_not_found",
    "message": "La empresa indicada no existe o no está en el ámbito de tu credencial.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#profile_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000004"
  }
}

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

200application/json

400application/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`

`application/json`