PApaylocity
PayStatements

Get employee pay statement summary data for the specified year.

Changed on

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}

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}
  • Auth
    OAuth 2
    Client credentials
    Token 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

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

autoPayboolean

.<br />

beginDatestring paylocity-date nullable

.<br />

checkDatestring paylocity-date nullable

.<br />

checkNumberinteger

.<br />

directDepositAmountnumber nullable

.<br />

endDatestring paylocity-date nullable

.<br />

grossPaynumber nullable

.<br />

hoursnumber nullable

.<br />

netChecknumber nullable

.<br />

netPaynumber nullable

.<br />

overtimeDollarsnumber nullable

.<br />

overtimeHoursnumber nullable

.<br />

processinteger

.<br />

regularDollarsnumber nullable

.<br />

regularHoursnumber nullable

.<br />

transactionNumberinteger
<br />
voucherNumberinteger

.<br />

workersCompCodestring nullable

.<br />

yearinteger

.<br />

Changes