v4
OpenAPI 3.0.02026-07-314441026.8 MBGet an employee's vacation pay balance for a work assignment
This endpoint gets an employee's vacation pay balance for a work assignment. The balance covers a reporting period (specified using period_start, period_end, or pay_date filters) and includes the opening balance, amount accrued, amount paid, and closing balance for that period.
If you need a detailed history of vacation pay accruals, payments, and adjustments by payroll, use the vacation pay history endpoint instead.
Query parameters
Filter results by the payrolls' period start dates.
Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: period_start=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:
- gt (greater than)
- gte (greater than or equal to)
- lte (less than or equal to)
- lt (less than) Example: period_start[gte]=2024-01-01&period_start[lt]=2024-12-31
Filter results by the payrolls' period end dates.
Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: period_end=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:
- gt (greater than)
- gte (greater than or equal to)
- lte (less than or equal to)
- lt (less than) Example: period_end[gte]=2024-01-01&period_end[lt]=2024-12-31
Filter results by the payrolls' pay dates.
Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: pay_date=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:
- gt (greater than)
- gte (greater than or equal to)
- lte (less than or equal to)
- lt (less than) Example: pay_date[gte]=2024-01-01&pay_date[lt]=2024-12-31
When true, includes the next (draft) payroll in the calculation.
When true, includes approved but not yet paid payrolls in the calculation.
Response
OK