Accrual Balance History

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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

attribute type description
success boolean Response status
data array Returned accrual data and corresponding policy code
errors array Contains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

| 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 | array of strings | required | IDs of any employees you would like to see accrual balance history for | | employeeIDs* | ADD string | | | | endDate | date | required | |

``200 200

``400 400

Updated 7 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \
     --url https://api.zeal.com/accrualBalance/history \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result

``400 - Result

Updated7 months ago