PayStatements
Get employee pay statement summary data for the specified year and check date.
Changed onGet pay statement summary API will return employee pay statement summary data currently available in Web Pay for the specified year and check date.
get/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}/{checkDate}
Request
- Base URLhttps://api.paylocity.com/api
- URLhttps://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}/{checkDate}
- AuthOAuth 2Client credentialsToken URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI
Path parameters
companyIdstring required
Company Id
employeeIdstring required
Employee Id
yearstring required
The year for which to retrieve pay statement data
checkDatestring required
The check date for which to retrieve pay statement data
Query parameters
pagesizeinteger
Number of records per page. Default value is 25.
pagenumberinteger
Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
includetotalcountboolean
Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
Response
Successfully Retrieved
Changes
- warning
deleted the
queryrequest parametercodegroup
- warning
- info
added the new optional
queryrequest parametercodegroup
- info