Factuarea APIDevelopers

Retrieve an employee’s monthly time sheet

Return the live monthly time sheet of an employee for the open (in-progress) period: expected vs worked minutes, the balance and overtime per day, and the monthly totals.

  • employee_id (UUID v7) is required; month (YYYY-MM) defaults to the current month.
  • The sheet is recomputed on every request from the immutable ledger, so a just-recorded clock entry is reflected without closing the month.
  • Expected minutes discount public holidays and approved absences.
  • Totals are in minutes.
  • A computed resource: it exposes employee_id, never an id.
GET
/time-balances/monthly-sheet
AuthorizationBearer <token>

In: header

Query Parameters

employee_id*string

Employee ID (UUID v7) whose monthly sheet to retrieve.

Formatuuid
month?|

Sheet month in YYYY-MM format; defaults to the current month.

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

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

application/json

application/json

application/json

application/json

application/json

application/json