GET api/EmployeeTransactionSummary

Get employees' transaction summaries with selected two period end dates

Request Information

URI Parameters

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

Name	Description	Type	Additional information
periodEndFrom Date		date	Required
periodEndToDate		date	Required
include Terminated	Set to true to include employees terminated in the current financial year, false to exclude all terminated employees (default).	boolean	Default value is False
empCode	Employee's code, default is blank.	string	Default value is
page	Page number, default is 1.	integer	Default value is 1
pageSize	Page size, default is 100.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

EmployeeTransactionSummaryView

Name	Description	Type	Additional information
idEmployee TransactionSummary		integer	None.
PeriodEndDate	The date of each period end	date	None.
PayFrequency	The pay frequency or cycle the Employee will be paid on.	string	None.
EmpCode	The unique code identifing the actual ChangeEmployee record in question. This code is required input on ALL requests.	string	None.
Surname	The employee's surname (last name/family name).	string	None.
FirstName	The employee's first name.	string	None.
PayrollCompany		string	None.
Location	The employee's location for payroll purposes.	string	None.
Job Classification	The employee's job classification.	string	None.
PayPoint		string	None.
EmploymentType		string	None.
ContractHoursPer Period		decimal number	None.
ContractHours PerDay		decimal number	None.
CompomentCode		string	None.
Compoment Description		string	None.
Hours		decimal number	None.
Days		decimal number	None.
Unit		decimal number	None.
Rate		decimal number	None.
Amount		decimal number	None.
LoadingRate		decimal number	None.
LoadingPercent		decimal number	None.
LoadingAmount		decimal number	None.
LeaveReason		string	None.
LeaveStartDate		date	None.
LeaveEndDate		date	None.

Response Formats

application/json, text/json

Sample:

{
  "idEmployeeTransactionSummary": 1,
  "periodEndDate": "2024-05-19T09:51:33.9753649+10:00",
  "payFrequency": "sample string 3",
  "empCode": "sample string 4",
  "surname": "sample string 5",
  "firstName": "sample string 6",
  "payrollCompany": "sample string 7",
  "location": "sample string 8",
  "jobClassification": "sample string 9",
  "payPoint": "sample string 10",
  "employmentType": "sample string 11",
  "contractHoursPerPeriod": 12.1,
  "contractHoursPerDay": 13.1,
  "compomentCode": "sample string 14",
  "compomentDescription": "sample string 15",
  "hours": 16.1,
  "days": 17.1,
  "unit": 18.1,
  "rate": 19.1,
  "amount": 20.1,
  "loadingRate": 21.1,
  "loadingPercent": 22.1,
  "loadingAmount": 23.1,
  "leaveReason": "sample string 24",
  "leaveStartDate": "2024-05-19T09:51:33.9753649+10:00",
  "leaveEndDate": "2024-05-19T09:51:33.9753649+10:00"
}

application/xml, text/xml

Sample:

<EmployeeTransactionSummaryView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <idEmployeeTransactionSummary>1</idEmployeeTransactionSummary>
  <PeriodEndDate>2024-05-19T09:51:33.9753649+10:00</PeriodEndDate>
  <PayFrequency>sample string 3</PayFrequency>
  <EmpCode>sample string 4</EmpCode>
  <Surname>sample string 5</Surname>
  <FirstName>sample string 6</FirstName>
  <PayrollCompany>sample string 7</PayrollCompany>
  <Location>sample string 8</Location>
  <JobClassification>sample string 9</JobClassification>
  <PayPoint>sample string 10</PayPoint>
  <EmploymentType>sample string 11</EmploymentType>
  <ContractHoursPerPeriod>12.1</ContractHoursPerPeriod>
  <ContractHoursPerDay>13.1</ContractHoursPerDay>
  <CompomentCode>sample string 14</CompomentCode>
  <CompomentDescription>sample string 15</CompomentDescription>
  <Hours>16.1</Hours>
  <Days>17.1</Days>
  <Unit>18.1</Unit>
  <Rate>19.1</Rate>
  <Amount>20.1</Amount>
  <LoadingRate>21.1</LoadingRate>
  <LoadingPercent>22.1</LoadingPercent>
  <LoadingAmount>23.1</LoadingAmount>
  <LeaveReason>sample string 24</LeaveReason>
  <LeaveStartDate>2024-05-19T09:51:33.9753649+10:00</LeaveStartDate>
  <LeaveEndDate>2024-05-19T09:51:33.9753649+10:00</LeaveEndDate>
</EmployeeTransactionSummaryView>