Llistar totes les polítiques d'absències

Llista les polítiques d'absències de la teva empresa amb paginació per cursor.

Admet filtrar per status (active/archived) i accrual_method (annual/monthly), més una search de text lliure sobre el nom de la política.

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25

Rang1 <= value <= 100

starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid

ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid

status?string

Estat del cicle de vida de la política d'absències. Coincidència exacta amb status.

Valor a"active" | "archived"

status[in]?string

Estat del cicle de vida de la política d'absències. Llista separada per comes. Coincideix qualsevol dels valors.

accrual_method?string

Mètode de meritació utilitzat per concedir el saldo d'absències. Coincidència exacta amb accrual_method.

Valor a"annual" | "monthly"

accrual_method[in]?string

Mètode de meritació utilitzat per concedir el saldo d'absències. Llista separada per comes. Coincideix qualsevol dels valors.

search?string

Cerca de text lliure. LIKE %term% escapat (sense distingir majúscules, màx. 80 caràcters) sobre les columnes de text clau del recurs, combinat amb la resta de filtres (AND) i compatible amb el cursor.

Longitudlength <= 80

Headers

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`

Exemple de petició

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/absence-policies?limit=25", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": [
    {
      "id": "01933a31-d176-7082-8e9f-6f7a8b9c0d01",
      "object": "absence_policy",
      "name": "Vacaciones estándar",
      "allowance_type": "limited",
      "allowance_days": 23,
      "accrual_method": "annual",
      "absence_type_ids": [
        "01933a30-c065-7f71-9d8e-5e6f7a8b9c01"
      ],
      "assigned_employee_count": 12,
      "status": "active",
      "carryover": {
        "type": "capped",
        "max_days": 5,
        "expiry_month": 3,
        "expiry_day": 31
      },
      "created_at": "2024-09-01T10:00:00Z",
      "updated_at": "2024-09-01T10:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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

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

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "Los parámetros 'starting_after' y 'ending_before' son mutuamente excluyentes.",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_2ef60c48387401cb14bd366d3b"
  }
}

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

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

Llistar totes les polítiques d'absències

Authorization

Paràmetres de consulta

Headers

Cos de la resposta

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`