GET Payroll/PayrollEntries

Returns a paged list of payroll entries, sorted by date descending. Employee self service user can only access their own payroll entries / payslips.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId Specifies the file id of the file to perform the operation upon. integer

Required
FromDate Filter records with Date greater than or equal to a date (must also specifiy ToDate). string

None.
ToDate Filter records with Date less than or equal to a date (must also specifiy FromDate). string

None.
EmployeeId Filter records by employee id. string

None.
Page Specifies the page number of the result set to return. integer

None.
PageSize Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. integer

None.

Body Parameters

None.

Response Information

Resource Description

PayrollEntrySummaryResponse
Name Description Type Additional information
TotalWages No documentation available. decimal number

None.
TotalDeductions No documentation available. decimal number

None.
TotalTaxes No documentation available. decimal number

None.
TotalNetPay No documentation available. decimal number

None.
TotalSuper No documentation available. decimal number

None.
PayrollEntries List of payroll entries. Collection of PayrollEntrySummary

None.
_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalWages": 1.0,
  "TotalDeductions": 2.0,
  "TotalTaxes": 3.0,
  "TotalNetPay": -4.0,
  "TotalSuper": 4.0,
  "PayrollEntries": [
    {
      "Id": 1,
      "PayRunId": 1,
      "Status": 2,
      "Date": "2023-12-02T16:39:23.2142529+11:00",
      "Employee": {
        "Id": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "DisplayName": "sample string 2, sample string 1",
        "IsActive": true,
        "EmploymentTypeId": 4,
        "EmploymentType": "sample string 5",
        "PayFrequencyId": 6,
        "PayFrequency": "sample string 7",
        "AssignedToPayGroupId": 8,
        "PayGroupName": "sample string 9",
        "LastPaid": "2023-12-02T16:39:23.2142529+11:00",
        "LeaveBalances": [
          {
            "PayItemId": 1,
            "Hours": 1.0
          },
          {
            "PayItemId": 1,
            "Hours": 1.0
          }
        ],
        "_links": [
          {
            "rel": "sample string 1",
            "href": "sample string 2",
            "method": "sample string 3",
            "title": "sample string 4"
          },
          {
            "rel": "sample string 1",
            "href": "sample string 2",
            "method": "sample string 3",
            "title": "sample string 4"
          }
        ]
      },
      "Wages": 4.0,
      "Deductions": 5.0,
      "Taxes": 6.0,
      "NetPay": -7.0,
      "Super": 7.0,
      "IsEmpty": false,
      "_links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "PayRunId": 1,
      "Status": 2,
      "Date": "2023-12-02T16:39:23.2142529+11:00",
      "Employee": {
        "Id": 1,
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "DisplayName": "sample string 2, sample string 1",
        "IsActive": true,
        "EmploymentTypeId": 4,
        "EmploymentType": "sample string 5",
        "PayFrequencyId": 6,
        "PayFrequency": "sample string 7",
        "AssignedToPayGroupId": 8,
        "PayGroupName": "sample string 9",
        "LastPaid": "2023-12-02T16:39:23.2142529+11:00",
        "LeaveBalances": [
          {
            "PayItemId": 1,
            "Hours": 1.0
          },
          {
            "PayItemId": 1,
            "Hours": 1.0
          }
        ],
        "_links": [
          {
            "rel": "sample string 1",
            "href": "sample string 2",
            "method": "sample string 3",
            "title": "sample string 4"
          },
          {
            "rel": "sample string 1",
            "href": "sample string 2",
            "method": "sample string 3",
            "title": "sample string 4"
          }
        ]
      },
      "Wages": 4.0,
      "Deductions": 5.0,
      "Taxes": 6.0,
      "NetPay": -7.0,
      "Super": 7.0,
      "IsEmpty": false,
      "_links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample: 
<PayrollEntrySummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
  </_links>
  <TotalWages>1</TotalWages>
  <TotalDeductions>2</TotalDeductions>
  <TotalTaxes>3</TotalTaxes>
  <TotalSuper>4</TotalSuper>
  <PayrollEntries>
    <PayrollEntrySummary>
      <_links>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
      </_links>
      <Id>1</Id>
      <PayRunId>1</PayRunId>
      <Status>2</Status>
      <Date>2023-12-02T16:39:23.2142529+11:00</Date>
      <Employee>
        <_links>
          <Link>
            <rel>sample string 1</rel>
            <href>sample string 2</href>
            <method>sample string 3</method>
            <title>sample string 4</title>
          </Link>
          <Link>
            <rel>sample string 1</rel>
            <href>sample string 2</href>
            <method>sample string 3</method>
            <title>sample string 4</title>
          </Link>
        </_links>
        <Id>1</Id>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <IsActive>true</IsActive>
        <EmploymentTypeId>4</EmploymentTypeId>
        <EmploymentType>sample string 5</EmploymentType>
        <PayFrequencyId>6</PayFrequencyId>
        <PayFrequency>sample string 7</PayFrequency>
        <AssignedToPayGroupId>8</AssignedToPayGroupId>
        <PayGroupName>sample string 9</PayGroupName>
        <LastPaid>2023-12-02T16:39:23.2142529+11:00</LastPaid>
        <LeaveBalances>
          <LeaveBalanceDto>
            <PayItemId>1</PayItemId>
            <Hours>1</Hours>
          </LeaveBalanceDto>
          <LeaveBalanceDto>
            <PayItemId>1</PayItemId>
            <Hours>1</Hours>
          </LeaveBalanceDto>
        </LeaveBalances>
      </Employee>
      <Wages>4</Wages>
      <Deductions>5</Deductions>
      <Taxes>6</Taxes>
      <Super>7</Super>
    </PayrollEntrySummary>
    <PayrollEntrySummary>
      <_links>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
      </_links>
      <Id>1</Id>
      <PayRunId>1</PayRunId>
      <Status>2</Status>
      <Date>2023-12-02T16:39:23.2142529+11:00</Date>
      <Employee>
        <_links>
          <Link>
            <rel>sample string 1</rel>
            <href>sample string 2</href>
            <method>sample string 3</method>
            <title>sample string 4</title>
          </Link>
          <Link>
            <rel>sample string 1</rel>
            <href>sample string 2</href>
            <method>sample string 3</method>
            <title>sample string 4</title>
          </Link>
        </_links>
        <Id>1</Id>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <IsActive>true</IsActive>
        <EmploymentTypeId>4</EmploymentTypeId>
        <EmploymentType>sample string 5</EmploymentType>
        <PayFrequencyId>6</PayFrequencyId>
        <PayFrequency>sample string 7</PayFrequency>
        <AssignedToPayGroupId>8</AssignedToPayGroupId>
        <PayGroupName>sample string 9</PayGroupName>
        <LastPaid>2023-12-02T16:39:23.2142529+11:00</LastPaid>
        <LeaveBalances>
          <LeaveBalanceDto>
            <PayItemId>1</PayItemId>
            <Hours>1</Hours>
          </LeaveBalanceDto>
          <LeaveBalanceDto>
            <PayItemId>1</PayItemId>
            <Hours>1</Hours>
          </LeaveBalanceDto>
        </LeaveBalances>
      </Employee>
      <Wages>4</Wages>
      <Deductions>5</Deductions>
      <Taxes>6</Taxes>
      <Super>7</Super>
    </PayrollEntrySummary>
  </PayrollEntries>
</PayrollEntrySummaryResponse>