Download the payroll export of a closed month

Download the payroll incidents file of a closed month for a Spanish payroll software, read from the frozen snapshot. - format is optional (a3 default, sage, nominasol); an unknown format returns 422. - A period without a close returns 404; the response is a binary spreadsheet.

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid

monthly_time_record_close*string

Public identifier (UUID v7) of the monthly time-record close.

Formatuuid

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

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/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/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"

Retired X-Active-Profile header sent

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

Malformed Factuarea-Version header

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

Unsupported Factuarea-Version

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

GET /v1/companies/{company}/monthly-time-record-closes/{monthly_time_record_close}/payroll-export · 403 insufficient_scope

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

Company deactivated

{
  "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}/monthly-time-record-closes/{monthly_time_record_close}/payroll-export · 404 resource_not_found

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

Company not found or outside the API key scope

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

400application/json

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`

`application/json`