Factuarea API
Tancaments mensuals del registre

Llistar tots els tancaments mensuals de registre de jornada

Llista els tancaments mensuals del registre de jornada de la teva empresa amb paginació per cursor, ordenats per període descendent. Admet filtrar per year. Cada element exposa el seu estat (closed/reopened), els límits del període i el nombre d'empleats.

GET
/monthly-time-record-closes
AuthorizationBearer <token>

A: header

Paràmetres de consulta

per_page?integer

Mida de pàgina. Àlies de limit (enter entre 1 i 100, per defecte 25).

Predeterminat25
Rang1 <= value <= 100
limit?integer

Mida de pàgina. Enter entre 1 i 100. Per defecte 25. Àlies de per_page; si s'envien tots dos, guanya limit.

Predeterminat25
Rang1 <= value <= 100
cursor?string

Cursor de paginació opac. NO ESTÀNDARD en aquesta API: a diferència dels llistats per cursor (starting_after/ending_before), aquest endpoint embolcalla una paginació per offset, així que el cursor codifica el número de la pàgina següent. Utilitza el valor next_cursor retornat per la pàgina anterior.

year?integer

Filtra els tancaments mensuals per any natural.

Paràmetres de capçalera

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
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

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