Download the payroll export of a closed month

Download the payroll incidents file of a closed month in the format of a Spanish payroll software (a3 for A3 Wolters Kluwer, sage for Sage, nominasol for NominaSOL), read from the frozen snapshot of the monthly close without recomputation.

Each row is one employee with their fiscal identity (tax ID and name), worked vs expected minutes, overtime, balance and the approved absences broken down by type.
format is optional and defaults to a3; a format outside the catalog returns 422. A period without a close returns 404. The response is a binary spreadsheet download.

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

monthly_time_record_close*string

Query Parameters

format?|

Payroll export format by software (defaults to a3).

Value in"a3" | "sage" | "nominasol" | null

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/vnd.openxmlformats-officedocument.spreadsheetml.sheet`

`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/monthly-time-record-closes/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/payroll-export", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"} },});if (!response.ok) throw new Error(await response.text());await (await import("node:fs/promises")).writeFile("response.bin", new Uint8Array(await response.arrayBuffer()));

Response example

Download the file using the response headers below.

HTTP/1.1 200
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: attachment; filename="registro-jornada-2026-04.xlsx"

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

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'payroll_exports:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_a65d8ca549c51b8e6cae86920d"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "resource_not_found",
    "message": "No existe ningún cierre del registro de jornada con el identificador '01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8aff'.",
    "subcode": "monthly_time_record_close_not_found",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_not_found",
    "request_id": "req_1ca8c94f9da15ce4443f1048d3"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo format no tiene un valor válido.",
    "param": "format",
    "errors": [
      {
        "param": "format",
        "code": "parameter_invalid_value",
        "message": "El campo format no tiene un valor válido."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_a75ae3b9c403dea217f5d1f0e6"
  }
}

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

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

Download the payroll export of a closed month

Authorization

Path Parameters

Query Parameters

Headers

Response Body

200application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`