v1
latestSwagger 2.02026-07-133225142.0 KBPayStatements
Get employee pay statement summary data for the specified year.
Get pay statement summary API will return employee pay statement summary data currently available in Web Pay for the specified year.
get/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}
Path parameters
companyIdstring required
Company Id
employeeIdstring required
Employee Id
yearstring required
The year 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.
codegroupstring
Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Response
Successfully Retrieved