Get Employee Balance Transactions

Balance transactions represent instances when employees earned and used their balances (for example, balances used by time away from work or incremented by entitlement policies).

Overview

The Get Employee Balance Transactions request allows the consuming application to search for employee balance transactions using a number of criteria. Required parameters for the call include employeeXRefCode and balanceXRefCode. The base URL used to retrieve a list of employee balance transactions is:

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

Parameters

Note: An asterisk (*) next to a parameter name denotes a required parameter.

employeeXRefCode* (string)

• Reference code of the employee for whom the balance transactions must be retrieved.

balanceXRefCode* (string)

• Reference code of the balance for whom the balance transactions must be retrieved.

startDate (string)

• Start date of the filter period for which employee balances transactions are returned.
• The date value should be expressed as yyyy-mm-ddThh:mm:ss where T is a separator used between the date and time. For example, 2021-01-01T13:24:56.
• If you don’t enter a date, the current date is used.

endDate (string)

• End date of the filter period for which employee balances transactions are returned.
• The date value should be expressed as yyyy-mm-ddThh:mm:ss where T is a separator used between the date and time. For example, 2021-12-31T16:24:11.
• If you don’t enter a date, the start date is used. If you don’t enter a start date, the current date is used.

Response

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

{
  "Data": [
    {
      "EmployeeBalancePeriodIdExternal": 0,
      "EffectiveStart": "2021-02-22T17:35:50.688Z",
      "EffectiveEnd": "2021-02-22T17:35:50.688Z",
      "Transactions": [
        {
          "TransactionDate": "2021-02-22T17:35:50.689Z",
          "ExpiryDate": "2021-02-22T17:35:50.689Z",
          "Delta": 0,
          "GrantDelta": 0,
          "TransactionSource": 0,
          "TAFWXRefCode": "string",
          "Comment": "string",
          "ApprovalStatus": "string"
        }
      ]
    }
  ],
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}