API Reference

Get Accrual Balance

get
https://api.zeal.com/accrualBalance
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Fetches an accrual balance corresponding to an accrual policy in Zeal's system.

Returns

Returns boolean indicating success status and a list of added or removed employees and corresponding policy code.

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

ID of the company

string

Filter by the unique code assigned to a policy

string

Filter by the employee assigned to a policy

string

Filter by status of the policy (accepts live or terminated)

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