Absence Policies

Create an absence policy

Create an absence policy for the company resolved from the API key; returns it with its generated id (UUID v7).

  • Required: name, allowance_type (limited/unlimited), accrual_method (annual/monthly); allowance_days is required and positive only when limited.
  • absence_type_ids lists covered types (may be empty); a type of another company returns 422.
post/companies/{company}/absence-policies

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/absence-policies
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

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

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

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.

Request body

namestring required

Absence policy name.

allowance_type'limited' | 'unlimited' required

Day allowance type: limited or unlimited.

allowance_daysinteger nullable

Days allotted per year (required and positive only when the allowance is limited).

accrual_method'annual' | 'monthly' required

Day accrual method: annual or monthly.

absence_type_idsstring[] required

Absence type IDs (UUID v7) associated with the policy (may be empty).

Response

Absence policy created. The Location header contains the canonical URL of the new absence policy.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.