Reads all Allowance stats

Retrieves the employee time off counters for a specific allowance with a reference date

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids[]
array of strings

A virtual ID for the allowance stat, composed of employee_id/allowance_id/reference_date. Cannot be used to fetch this resource.

ids[]
employee_ids[]
array of strings

Get the allowance stats for specific employees

employee_ids[]
allowance_ids[]
array of strings

Filter the stats by these allowance IDs

allowance_ids[]
string

The reference date to calculate the allowance stats. If not provided, it will use today's date.

string

When provided, computes the stats as if the employee were moved to this target time off policy effective the day AFTER reference_date, so pass the day before the change date - for a change effective on 2026-08-03, send reference_date=2026-08-02. This truncates the source policy's current cycle at that boundary so available_days reflects the prorated balance that would actually transfer or be discarded on the change, rather than the full entitlement. Purely a read - nothing is persisted. Requires the policy timeline feature; without it the result is identical to an un-simulated read.

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json