Sign in

v4

OpenAPI 3.0.02026-07-314441026.8 MB
Vacation Pay

Get an employee's vacation pay history for a work assignment

This endpoint gets an employee's vacation pay history for a work assignment. The history includes one record per payroll in a reporting period (specified using period_start, period_end, or pay_date filters) and includes the opening balance, amount accrued, amount paid, closing balance, and any balance adjustment line items for the payroll, as well as basic payroll details.

If you just need a vacation pay balance, use the vacation pay balance endpoint instead.

get/vacation_pay_history

Query parameters

work_assignment_idstring required
period_startobject

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
period_endobject

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
pay_dateobject

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
include_next_payrollsboolean

When true, includes the next (draft) payroll in the results.

include_approved_payrollsboolean

When true, includes approved but not yet paid payrolls in the results.

sort'pay_date'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

Response

OK

objectstring

The type of the object in Nmbr ("list").