GET api/DeletedEmployees

The call gets a list of payroll employees who are no longer available because they were deleted from payroll on or after the specified date.This enables you to action the corresponding records in your system.

This endpoint is for MicrOpay only.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

NameDescriptionTypeAdditional information
deletedSince

Only include employees deleted since this date (mandatory). Date Format should be yyyy-mm-dd. A time can be appended to the date using the format: Thh:mm:ss were T is the symbol denoting time

 date

Required

Body Parameters

None.

Response Information

Resource Description

List of deleted employees with EmpId, EmpCode and a date when the employee is deleted.

DeletedEmployeesView
NameDescriptionTypeAdditional information
EmpId

Database ID of the Employee record. This is the unique ID to track EmpCode changes in this payroll database.

integer

None.
EmpCode

The code identifying the actual Employee record.

string

None.
DeletedDate

The date when the employee is deleted in Payroll database.

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "empId": 2,
  "empCode": "sample string 3",
  "deletedDate": "2024-12-04T09:47:12.1920348+11:00"
}

application/xml, text/xml

Sample: 
<DeletedEmployeesView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <idDeletedEmployees>1</idDeletedEmployees>
  <EmpId>2</EmpId>
  <EmpCode>sample string 3</EmpCode>
  <DeletedDate>2024-12-04T09:47:12.1920348+11:00</DeletedDate>
</DeletedEmployeesView>