Obtenir el full horari mensual d'un empleat

Retorna el full horari mensual en viu d'un empleat per al període obert: minuts esperats davant de treballats, saldo i hores extra per dia, i totals (minuts). - employee_id és obligatori; month (YYYY-MM) per defecte és el mes actual. - total_* projecten el mes complet; to_date conté els dies tancats fins a through_date.

Recurs calculat: sense id.

Authorization

AuthorizationBearer <token>

La teva API key com a token Bearer: fact_live_… en producció, fact_test_… en sandbox. Consulta la guia d'autenticació.

A: header

Paràmetres de ruta

company*string

Identificador públic (UUID v7) de l'empresa. Obtén-lo de GET /v1/me (data.scope[].id).

Formatuuid

Paràmetres de consulta

employee_id*string

ID de l'empleat (UUID v7) de qui es consulta el full mensual.

Formatuuid

month?|

Mes del full en format AAAA-MM; per defecte, el mes actual.

Coincidència^\d{4}-(0[1-9]|1[0-2])$

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

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/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/time-balances/monthly-sheet?employee_id=01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01", {  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": "time_sheet",
    "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "month": "2026-05",
    "total_expected_minutes": 9600,
    "total_worked_minutes": 7290,
    "total_balance_minutes": -2310,
    "total_overtime_minutes": 60,
    "to_date": {
      "through_date": "2026-05-24",
      "expected_minutes": 7200,
      "worked_minutes": 7290,
      "balance_minutes": 90,
      "overtime_minutes": 60
    },
    "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
      },
      {
        "date": "2026-05-25",
        "expected_minutes": 480,
        "worked_minutes": 0,
        "balance_minutes": -480,
        "overtime_minutes": 0,
        "is_holiday": false,
        "is_approved_absence": false,
        "is_rest_day": false,
        "is_unscheduled": false,
        "is_outside_employment": false
      }
    ]
  }
}

S'ha enviat la capçalera X-Active-Profile retirada

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

Capçalera Factuarea-Version malformada

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

Factuarea-Version no admesa

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

GET /v1/companies/{company}/time-balances/monthly-sheet · 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_b28bbd8ee0ac1d1bf93df732fb"
  }
}

Empresa desactivada

{
  "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/monthly-sheet · 404 resource_not_found

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "El recurso solicitado no existe.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_dd8c620b1efd86c6eef5266190"
  }
}

Empresa no trobada o fora de l'abast de l'API key

{
  "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 employee_id no tiene un valor válido.",
    "param": "employee_id",
    "errors": [
      {
        "param": "employee_id",
        "code": "parameter_invalid_value",
        "message": "El campo employee_id no tiene un valor válido."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_538f5205bd598482061f3b5ec8"
  }
}

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

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

Obtenir el full horari mensual d'un empleat

Authorization

Paràmetres de ruta

Paràmetres de consulta

Headers

Cos de la resposta

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`