List all monthly time record closes
List the monthly closes of the time record register of your company with cursor-based pagination, ordered by period descending. Supports filtering by year. Each item exposes its status (closed/reopened), period bounds and employee count.
In: header
Query Parameters
Page size. Alias of limit (integer between 1 and 100, defaults to 25).
251 <= value <= 100Page size. Integer between 1 and 100. Defaults to 25. Alias of per_page; if both are sent, limit wins.
251 <= value <= 100Opaque pagination cursor. NON-STANDARD for this API: unlike the cursor lists (starting_after/ending_before), this endpoint wraps an offset paginator, so the cursor encodes the next page number. Use the next_cursor value returned by the previous page.
Filter monthly closes by calendar year.
Header Parameters
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.
dateOperate 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.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
import { Factuarea } from "@factuarea/sdk";const factuarea = new Factuarea({ apiKey: process.env.FACTUAREA_API_KEY! });// List endpoints return an async-iterable Page (cursors handled for you).for await (const item of await factuarea.monthlyTimeRecordCloses.list({ limit: 25 })) { console.log(item.id);}{
"has_more": true,
"next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c",
"data": [
{
"id": "01933a40-04a9-73b5-9bc2-9c0d1e2f3a01",
"object": "monthly_time_record_close",
"year": 2026,
"month": 4,
"status": "closed",
"period_start": "2026-04-01",
"period_end": "2026-04-30",
"closed_by_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5ecc",
"closed_at": "2026-05-02T08:00:00Z",
"reopened_by_id": null,
"reopened_at": null,
"employee_count": 12,
"is_sealed": true
}
]
}{
"error": {
"type": "authentication_error",
"code": "missing_api_key",
"message": "No se ha proporcionado una API key válida en el header Authorization.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
"request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
}
}{
"error": {
"type": "authorization_error",
"code": "insufficient_scope",
"message": "Esta API key no tiene el scope requerido para esta operación.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
"request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
"request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
"param": null,
"doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
"request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
}
}