GET api/TimePunches?fromDate={fromDate}&toDate={toDate}&companyCodes={companyCodes}
Gets the earnings data for all the employees of the companies in the list between the passed in dates.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| fromDate | Start date. |
Define this parameter in the request URI. |
| toDate | End date. |
Define this parameter in the request URI. |
| companyCodes | The company codes as a comma delimited list. |
Define this parameter in the request URI. |
Request body formats
application/x-www-form-urlencoded
Sample:
api/TimePunches?fromDate=2024-12-25&toDate=2024-12-26&companyCodes=123,ABC[&frmt=xml|&frmt=json]
Response Information
List of Earnings.
Response body formats
text/json, application/json
Sample:
[
{
"BusinessUnit_Cd": "ABC123",
"Company_Cd": "123",
"Department_Cd": "ABC123",
"Division_Cd": "000",
"Employee_Cd": "EMPLOYEE1",
"Employee_Id": 1,
"Hours": 3.0,
"LastUpdated_Dt": "2024-12-26T06:17:53.974",
"Location_Cd": "",
"Pay_Cd": "R",
"Punches": [
{
"Type": "In",
"PunchTimeDate": "2024-12-25T08:00:00"
},
{
"Type": "OutLunch",
"PunchTimeDate": "2024-12-25T11:00:00"
}
],
"Rate": 25.0,
"Report_Dt": "2024-12-25T11:00:00",
"Type": "Punch",
"Units": 0.0
},
{
"BusinessUnit_Cd": "ABC123",
"Company_Cd": "123",
"Department_Cd": "ABC123",
"Division_Cd": "000",
"Employee_Cd": "EMPLOYEE1",
"Employee_Id": 1,
"Hours": 5.0,
"LastUpdated_Dt": "2024-12-26T06:17:53.974",
"Location_Cd": "",
"Pay_Cd": "R",
"Punches": [
{
"Type": "InLunch",
"PunchTimeDate": "2024-12-25T12:00:00"
},
{
"Type": "Out",
"PunchTimeDate": "2024-12-25T17:00:00"
}
],
"Rate": 25.0,
"Report_Dt": "2024-12-25T17:00:00",
"Type": "Punch",
"Units": 0.0
},
{
"BusinessUnit_Cd": "123ABC",
"Company_Cd": "ABC",
"Department_Cd": "123ABC",
"Division_Cd": "ABC",
"Employee_Cd": "EMPLOYEE2",
"Employee_Id": 2,
"Hours": 3.0,
"LastUpdated_Dt": "2024-12-26T06:17:53.974",
"Location_Cd": "",
"Pay_Cd": "R",
"Punches": [
{
"Type": "In",
"PunchTimeDate": "2024-12-25T08:00:00"
},
{
"Type": "OutLunch",
"PunchTimeDate": "2024-12-25T11:00:00"
}
],
"Rate": 14.0,
"Report_Dt": "2024-12-25T00:00:00",
"Type": "Punch",
"Units": 0.0
},
{
"BusinessUnit_Cd": "123ABC",
"Company_Cd": "ABC",
"Department_Cd": "123ABC",
"Division_Cd": "ABC",
"Employee_Cd": "EMPLOYEE2",
"Employee_Id": 2,
"Hours": 3.0,
"LastUpdated_Dt": "2024-12-26T06:17:53.974",
"Location_Cd": "",
"Pay_Cd": "O",
"Punches": [
{
"Type": "In",
"PunchTimeDate": "2024-12-25T08:00:00"
},
{
"Type": "OutLunch",
"PunchTimeDate": "2024-12-25T11:00:00"
}
],
"Rate": 7.0,
"Report_Dt": "2024-12-25T08:00:00",
"Type": "Punch",
"Units": 0.0
}
]
text/xml, application/xml
Sample:
<ArrayOfAllEarning xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.API.External.Models">
<AllEarning>
<BusinessUnit_Cd>ABC123</BusinessUnit_Cd>
<Company_Cd>123</Company_Cd>
<Department_Cd>ABC123</Department_Cd>
<Division_Cd>000</Division_Cd>
<Employee_Cd>EMPLOYEE1</Employee_Cd>
<Employee_Id>1</Employee_Id>
<Hours>3</Hours>
<LastUpdated_Dt>2024-12-26T06:17:53.974</LastUpdated_Dt>
<Location_Cd></Location_Cd>
<Pay_Cd>R</Pay_Cd>
<Punches>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T08:00:00</PunchTimeDate>
<Type>In</Type>
</CalculatedTimePunch>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T11:00:00</PunchTimeDate>
<Type>OutLunch</Type>
</CalculatedTimePunch>
</Punches>
<Rate>25</Rate>
<Report_Dt>2024-12-25T11:00:00</Report_Dt>
<Type>Punch</Type>
<Units>0</Units>
</AllEarning>
<AllEarning>
<BusinessUnit_Cd>ABC123</BusinessUnit_Cd>
<Company_Cd>123</Company_Cd>
<Department_Cd>ABC123</Department_Cd>
<Division_Cd>000</Division_Cd>
<Employee_Cd>EMPLOYEE1</Employee_Cd>
<Employee_Id>1</Employee_Id>
<Hours>5</Hours>
<LastUpdated_Dt>2024-12-26T06:17:53.974</LastUpdated_Dt>
<Location_Cd></Location_Cd>
<Pay_Cd>R</Pay_Cd>
<Punches>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T12:00:00</PunchTimeDate>
<Type>InLunch</Type>
</CalculatedTimePunch>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T17:00:00</PunchTimeDate>
<Type>Out</Type>
</CalculatedTimePunch>
</Punches>
<Rate>25</Rate>
<Report_Dt>2024-12-25T17:00:00</Report_Dt>
<Type>Punch</Type>
<Units>0</Units>
</AllEarning>
<AllEarning>
<BusinessUnit_Cd>123ABC</BusinessUnit_Cd>
<Company_Cd>ABC</Company_Cd>
<Department_Cd>123ABC</Department_Cd>
<Division_Cd>ABC</Division_Cd>
<Employee_Cd>EMPLOYEE2</Employee_Cd>
<Employee_Id>2</Employee_Id>
<Hours>3</Hours>
<LastUpdated_Dt>2024-12-26T06:17:53.974</LastUpdated_Dt>
<Location_Cd></Location_Cd>
<Pay_Cd>R</Pay_Cd>
<Punches>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T08:00:00</PunchTimeDate>
<Type>In</Type>
</CalculatedTimePunch>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T11:00:00</PunchTimeDate>
<Type>OutLunch</Type>
</CalculatedTimePunch>
</Punches>
<Rate>14</Rate>
<Report_Dt>2024-12-25T00:00:00</Report_Dt>
<Type>Punch</Type>
<Units>0</Units>
</AllEarning>
<AllEarning>
<BusinessUnit_Cd>123ABC</BusinessUnit_Cd>
<Company_Cd>ABC</Company_Cd>
<Department_Cd>123ABC</Department_Cd>
<Division_Cd>ABC</Division_Cd>
<Employee_Cd>EMPLOYEE2</Employee_Cd>
<Employee_Id>2</Employee_Id>
<Hours>3</Hours>
<LastUpdated_Dt>2024-12-26T06:17:53.974</LastUpdated_Dt>
<Location_Cd></Location_Cd>
<Pay_Cd>O</Pay_Cd>
<Punches>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T08:00:00</PunchTimeDate>
<Type>In</Type>
</CalculatedTimePunch>
<CalculatedTimePunch>
<PunchTimeDate>2024-12-25T11:00:00</PunchTimeDate>
<Type>OutLunch</Type>
</CalculatedTimePunch>
</Punches>
<Rate>7</Rate>
<Report_Dt>2024-12-25T08:00:00</Report_Dt>
<Type>Punch</Type>
<Units>0</Units>
</AllEarning>
</ArrayOfAllEarning>