v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Accrual Balance History

View accrual balance history specific filters within a company

post/accrualBalance/history

Request body

companyIDstring required

ID of the company

policyCodestring required

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

employeeIDsstring[] required

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

endDatestring date required

Response

200

successboolean

testModeboolean

Example response

{
  "data": [
    {
      "employeeID": "66722ff005a48848507d75d9",
      "policyName": "sick_leave",
      "totalAccrued": "7.45",
      "totalBalance": "21.64",
      "totalUsage": "17.00",
      "history": [
        {
          "reportingPeriodID": "6580ce4a3808d60023b4e17d",
          "checks": [
            "36cd1ff3857d4e9585aa18e93c6e62e2"
          ],
          "balance": "26.29",
          "accrued": "2.61",
          "usage": "0.00"
        }
      ]
    }
  ],
  "success": true
}