Create a time off policy

Crew module

POST/time-off-policiestimeOffPolicies.create

A time off policy. Creates a time off policy. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.payroll.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TimeOffPolicyCreate

timeOffPolicies.create: TimeOffPolicyCreate
Field	Type	Required	Description
name	string	Yes	Policy name.Constraints: length 1 to 300
accrual_hours_per_period	number \| null	No	Hours accrued per pay period.

{
  "name": "Paid Time Off",
  "accrual_hours_per_period": 3.08
}

Response 201: TimeOffPolicy

timeOffPolicies.create: TimeOffPolicy
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the time off policy.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Policy name.Constraints: length 1 to 300
accrual_hours_per_period	number \| null	Yes	Hours accrued per pay period.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Paid Time Off",
  "accrual_hours_per_period": 3.08
}

Code samples

curl -X POST "$XOS_BASE_URL/time-off-policies" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Paid Time Off","accrual_hours_per_period":3.08}'

const { data } = await xos.timeOffPolicies.create({
    "name": "Paid Time Off",
    "accrual_hours_per_period": 3.08
  });

response = xos.time_off_policies.create({"name": "Paid Time Off", "accrual_hours_per_period": 3.08})

xos time-off-policies create --data '{"name":"Paid Time Off","accrual_hours_per_period":3.08}'