Leave Policy

Use leave policies when you need to understand the rules that generate leave entitlements and accrual transactions for a worker.

Attributes

string

Unique identifier for the leave policy, for example lvp_Xk9mPq2vR8tn3e.

string

Human-readable policy name.

string | null

Plain-language explanation of the policy’s legal or company basis.

string

Leave type the policy applies to, for example vacation or sick_time_off.

string

Whether the policy sets the base entitlement or adds on top of it. One of set or add.

string

Unit used for all policy quantities. One of days or hours.

string

Lifecycle state for the policy. One of draft, active, or archived.

string | null

Workspace that owns the policy. Returns null for platform-managed policies.

string | null

CEL expression that determines which workers match this policy. The expression is evaluated against the same worker shape returned by the worker resource and worker GET API, so you can reference fields such as worker.id, worker.type, worker.workspace, worker.employment.status, worker.employment.starts, worker.employment.location.address.country, and worker.reporting.department.name. Returns null when the policy must be assigned manually.

object

Period definition used to reset the balance window.

Show child attributes

number

Month the leave period starts when the policy uses a fixed annual reset.

number

Day of month the leave period starts when the policy uses a fixed annual reset.

string

Worker date source used for anniversary-based periods. Currently starts.

object | null

Accrual rule for the policy.

Show child attributes

number

Amount granted per accrual period when the policy does not use tiers.

string

Rate denominator. One of year, month, pay_period, or hour.

string

Frequency used to create accrual transactions.

number

Hour ratio when per is hour, for example 30 for one hour per 30 hours worked.

object | null

Waiting period before accrual begins.

array | null

Tenure-based accrual tiers.

object | null

Carryover rule. Returns null for use-it-or-lose-it policies.

object | null

Minimum and maximum balance bounds for the policy.

object | null

Per-period usage limits. Returns null when there is no additional usage cap.

object

Termination payout rule for unused balance.

string

ISO 8601 timestamp of when the policy was created.

string

ISO 8601 timestamp of the most recent update to the policy.

{
  "id": "lvp_Xk9mPq2vR8tn3e",
  "name": "France — Paid Vacation",
  "description": "French labor law mandates 25 business days of paid vacation per year.",
  "type": "vacation",
  "effect": "set",
  "unit": "days",
  "status": "active",
  "workspace": null,
  "eligibility": "worker.employment.location.address.country == \"FR\"",
  "period": {
    "month": 6,
    "day": 1
  },
  "accrual": {
    "amount": 25,
    "per": "year",
    "credit": "month",
    "after": null
  },
  "carryover": {
    "max": 5,
    "expires": null
  },
  "balance": {
    "min": 0,
    "max": null
  },
  "usage": null,
  "payout": {
    "termination": "required"
  },
  "created": "2026-03-01T00:00:00Z",
  "updated": "2026-03-01T00:00:00Z"
}

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

Attributes

​Attributes

Attributes