GetCurrentPayRunStatus
URL

https://go.paycycle.com.au/API/PayRun/PayRun.svc/GetCurrentPayRunStatus

Description

This method retrieves details of the current unposted pay run for the customer making the request

Input

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

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

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

    </GetCurrentPayRunStatusRequest>

Output

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

        <Status/>OK</Status>

        <ErrorDescription/></ErrorDescription>

        <PayRun>

            <PayRunID/>257412</PayRunID>

            <StartDate/>2011-04-01T00:00:00</StartDate>

            <EndDate/>2011-04-30T00:00:00</EndDate>

            <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>

        </PayRun>

    </GetCurrentPayRunStatusResponse>

 

The pay run returned consists of the start and end dates for the pay run, and a list of employees. Employee ID is the internal identifier for the employee. HasOrdinaryEarningsRate indicates whether the employee has an ordinary earnings rate in Paycycle. The service method SetEarningsNumberOfUnits will not work for an employee unless they have an ordinary earnings rate.