At the end of the pay period, Integrators will need to transfer time card data from WFH to the external payroll system.
Time card activity data can be retrieved using the Get Time Card Export endpoint.
With this endpoint, you can get time card activity data for a list of employees (or all employees) for a specified date range, indicated by passing beginDate and endDate parameters. The payroll data is returned formatted according to the requested Payroll Provider format. If no format is specified, the data will be returned using the SUM3 format, which looks like this:
{
"Error": null,
"FormatBinary": null,
"FormatString": "\"RecordType\",\"ClientName\",\"ClientTag\",\"EmployeeCode\",\"EmployeeName\",\"EmployeeSSN\",\"Category\",\"CategoryCode\",\"Hours\",\"PayRate\",
\"PayRateUnmultiplied\",\"X\",\"Y\",\"Z\",\"Pay\",\"StartDate\",\"EndDate\",\"HomeDepartment\",\"HomeLocation\",\"HomeSupervisor\"\r\n\"SUM3\",\"Suz Co\",\"Suz20210416\",
\"7757869432855804\",\"Drew, Nan\",\"\",\"Regular\",\"\",\"18.00\",\"\",\"\",\"\",\"\",\"\",\"0\",\"2021-04-26\",,\"\",\"\",\"\"\r\n\"SUM3\",\"Suz Co\",\"Suz20210416\",
\"JS1234\",\"Snow, Jon\",\"\",\"Regular\",\"\",\"12.00\",\"\",\"\",\"\",\"\",\"\",\"0\",\"2021-01-02\",,\"\",\"\",\"\"\r\n",
"MimeType": "text/plain"
}
If the integrator wanted to get the same data in an alternate format, such as ADP8, it could be done like this:
GET /api/timeCardExport?ids=7757869432855804, JS1234&beginDate=2022-01-01T00:00:00.00&endDate=2022-03-14T23:24:25.00&idType=employeeCode&format=ADP8 Authorization: Bearer Content-Type: application/json Content Body: No content body
Which would return the results in the following format:
{
"Error": null,
"FormatBinary": null,
"FormatString": "Co Code,Batch Id,File #,Pay #,Temp Dept,Reg Hours,O/T Hours,Hours 3 Code,Hours 3 Amount,Earnings 3 Code,Earnings 3 Amount,Overtime,Doubletime,Holiday,,Sick,
Vacation,Commission,Bonus,Correction Payment,Family Leave\r\n\"Suz20210416\",90,\"7757869432855804\",,,18,,,,,\r\n\"Suz20210416\",90,\"JS1234\",,,12,,,,,\r\n",
"MimeType": "text/plain"
}