Get Employee Balance Periods

This request is used to get a list of an employee's entitlement balances.

Overview

The Get Employee Balance Periods request allows the consuming application to search for employee balance periods. The base URL used to retrieve a list of employee balance transactions is:

https://www.dayforcehcm.com/api/CompanyName/V1/EmployeeBalancePeriods

Parameters

employeeXRefCode* (string)

• The reference code of the employee for whom the balance period must be retrieved.

asOfDate (string)

• The date from which to calculate the current values for the employee balance period. If omitted, current values are calculated as of the current date. For example, 2020-01-01T00:00:00.

startDate (string)

• The period start date used to determine which employee balance periods are retrieved. If omitted, the current date is used. For example, 2020-01-01T00:00:00.

endDate (string)

• The period end date used to determine which employee balance periods are retrieved. If omitted, the period start date is used. If the period start date is also omitted, the current date is used. For example, 2020-01-01T00:00:00.

Response

The response is in JSON format as illustrated in the example below:

{
  "Data": [
    {
      "EmployeeXRefCode": "string",
      "BalanceName": "string",
      "BalanceXRefCode": "string",
      "EffectiveStart": "2021-03-09T19:31:05.537Z",
      "EffectiveEnd": "2021-03-09T19:31:05.537Z",
      "InitialAccruedValue": 0,
      "InitialGrantValue": 0,
      "CurrentAccruedValue": 0,
      "CurrentGrantValue": 0,
      "MinimumValue": 0,
      "MaximumValue": 0
    }
  ],
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}