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

Attributes

id
string
Unique identifier for the leave policy, for example lvp_Xk9mPq2vR8tn3e.
name
string
Human-readable policy name.
description
string | null
Plain-language explanation of the policy’s legal or company basis.
type
string
Leave type the policy applies to, for example vacation or sick_time_off.
effect
string
Whether the policy sets the base entitlement or adds on top of it. One of set or add.
unit
string
Unit used for all policy quantities. One of days or hours.
status
string
Lifecycle state for the policy. One of draft, active, or archived.
workspace
string | null
Workspace that owns the policy. Returns null for platform-managed policies.
applies
object | null
JSON Logic expression that determines which workers match this policy. Returns null when the policy must be assigned manually.
period
object
Period definition used to reset the balance window.
accrual
object | null
Accrual rule for the policy.
carryover
object | null
Carryover rule. Returns null for use-it-or-lose-it policies.
balance
object | null
Minimum and maximum balance bounds for the policy.
usage
object | null
Per-period usage limits. Returns null when there is no additional usage cap.
payout
object
Termination payout rule for unused balance.
created
string
ISO 8601 timestamp of when the policy was created.
updated
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,
  "applies": {
    "==": [{ "var": "worker.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"
}