Entitlements

Time-off balances for a person. Tracks allocated, used, and pending (approved but not taken) days for a specific absence category (event) and period. Updated automatically as bookings and approvals are processed.

Attributes

allocated number
Response Request Parameter `filter`

Total hours allocated to this person for the absence category in the entitlement period.

approval_workflow approval workflow
Response

Whether an approval workflow is required for absence requests under this entitlement.

date string
Parameter `filter`

The reference date for this entitlement record (typically the start of the accrual period).

end_date string
Response Request Parameter `filter` Parameter `sort`

The date when this entitlement period ends. After this date, unused hours may expire.

event event
Response Parameter `sort`

The absence category (event) this entitlement is for, such as vacation or sick leave.

event_id integer
Request Parameter `filter`

The ID of the absence category (event) this entitlement covers.

id integer
Parameter `filter`

The unique identifier of this entitlement record.

note string
Response Request

Optional note providing additional context for this entitlement allocation.

organization organization
Response

The organization this entitlement belongs to.

pending number
Response

Hours pending approval — absence bookings submitted but not yet approved.

person person
Response Parameter `sort`

The person this entitlement applies to.

person_id integer
Request Parameter `filter`

The ID of the person this entitlement applies to.

start_date string
Response Request Parameter `filter` Parameter `sort`

The date when this entitlement period starts.

used number
Response Parameter `filter`

Hours already used — approved absence bookings that have been taken within the entitlement period.