NMnmbr
Vacation Pay

Get 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.

get/vacation_pay_balance

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

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 calculation.

include_approved_payrollsboolean

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

Response

OK

objectstring

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

Changes

No recorded changes to this operation across all 54 revisions of this API.