---
title: "Get an employee's vacation pay balance for a work assignment"
method: GET
path: "/vacation_pay_balance"
tags: ["Vacation Pay"]
---

# Get an employee's vacation pay balance for a work assignment

`GET /vacation_pay_balance`

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

- `work_assignment_id` string, required
- `period_start` object
- `period_end` object
- `pay_date` object
- `include_next_payrolls` boolean
- `include_approved_payrolls` boolean

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"vacation_pay_balance"`).
    - `data` VacationPayBalance
      - `vacation_pay_opening_balance` number, nullable
      - `vacation_pay_accrued_in_period` number, nullable
      - `vacation_pay_paid_in_period` number, nullable
      - `vacation_pay_closing_balance` number, nullable

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/01cd9c45a923/schema)