Help Page Home - Payroll
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
PayrollEntrySummaryResponseName | Description | Type | Additional information |
---|---|---|---|
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:
{ "PayrollEntries": [ { "Id": 1, "Date": "2023-06-03T04:58:01.1833271+10:00", "Employee": { "Id": 1, "FirstName": "sample string 1", "LastName": "sample string 2", "IsActive": true, "_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": 3.0, "Deductions": 4.0, "Taxes": 5.0, "NetPay": -6.0, "Super": 6.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" } ] }, { "Id": 1, "Date": "2023-06-03T04:58:01.1833271+10:00", "Employee": { "Id": 1, "FirstName": "sample string 1", "LastName": "sample string 2", "IsActive": true, "_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": 3.0, "Deductions": 4.0, "Taxes": 5.0, "NetPay": -6.0, "Super": 6.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" } ] } ], "_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> <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> <Date>2023-06-03T04:58:01.1833271+10: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> </Employee> <Wages>3</Wages> <Deductions>4</Deductions> <Taxes>5</Taxes> <Super>6</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> <Date>2023-06-03T04:58:01.1833271+10: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> </Employee> <Wages>3</Wages> <Deductions>4</Deductions> <Taxes>5</Taxes> <Super>6</Super> </PayrollEntrySummary> </PayrollEntries> </PayrollEntrySummaryResponse>