GetAllEmployees
URL

https://go.paycycle.com.au/API/Employee/Employee.svc/GetAllEmployees

Description

This method retrieves all employees associate with the customer making the request.

Input

    <GetAllEmployeesRequest xmlns="http://api.paycycle.com.au/v1.0">

        <ApiKey/>00000000-0000-0000-0000-000000000000</ApiKey>

        <AuthorisationKey/>00000000-0000-0000-0000-000000000000</AuthorisationKey>

    </GetAllEmployeesRequest>

Output

    <GetAllEmployeesResponse xmlns="http://api.paycycle.com.au/v1.0">

        <Status/>OK</Status>

        <ErrorDescription/></ErrorDescription>

        <Employees>

            <Employee>

                <EmployeeID/>2022</EmployeeID>

                <FirstGivenName/>John</FirstGivenName>

                <HasOrdinaryEarningsRate/>true</HasOrdinaryEarningsRate>

                <Surname/>Smith</Surname>

            </Employee>

            <Employee>

                <EmployeeID/>2062</EmployeeID>

                <FirstGivenName/>Jane</FirstGivenName>

                <HasOrdinaryEarningsRate/>false</HasOrdinaryEarningsRate>

                <Surname/>Johnson</Surname>

            </Employee>

        </Employees>

    </GetAllEmployeesResponse>

 

The response is a list of all employee is found for the customer making the request. Employee ID is the internal identifier for the employee. HasOrdinaryEarningsRate indicates whether the employee has an ordinary earnings rate in Paycycle.