API Reference

Accrual Balance History

post
https://api.zeal.com/accrualBalance/history

View accrual balance history specific filters within a company

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint is used to get array of accruals with usage that's organized by the reportingPeriodID. It will include any number of checks that would be connected to usage.


Note: The accrual balance history endpoint only provides a historical view of items within the specific year of an end date (YTD accruals)

Returns

attributetypedescription
successbooleanResponse status
dataarrayReturned accrual data and corresponding policy code
errorsarrayContains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

ID of the company

string
required

The unique identifier for the accrual policy under which the usage is being applied

employeeIDs
array of strings
required

IDs of any employees you would like to see accrual balance history for

employeeIDs*
date
required
Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago