---
title: "Accrual Balance History"
method: POST
path: "/accrualBalance/history"
---

# Accrual Balance History

`POST /accrualBalance/history`

## Request

- Base URL: `https://api.zeal.com`
- URL: `https://api.zeal.com/accrualBalance/history`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/zeal/apis/zeal-api/docs/accrualBalance/history/post.ts> (a function with typed inputs; its response is checked against the schema)

View accrual balance history specific filters within a company

## Request body

- object
  - `companyID` string, required: ID of the company
  - `policyCode` string, required: The unique identifier for the accrual policy under which the usage is being applied
  - `employeeIDs` string[], required: IDs of any employees you would like to see accrual balance history for
  - `endDate` string, date, required

## Response `200`

200

- object
  - `data` object[]
    - `employeeID` string
    - `policyName` string
    - `totalAccrued` string
    - `totalBalance` string
    - `totalUsage` string
    - `history` object[]
      - `reportingPeriodID` string
      - `checks` string[]
      - `balance` string
      - `accrued` string
      - `usage` string
  - `success` boolean
  - `testMode` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/zeal/apis/zeal-api.md) - [All operations](https://skmtc.dev/zeal/apis/zeal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeal/apis/zeal-api/revisions/01346dceb27d?raw)