PApaylocity
PayStatements

Get employee pay statement details data for the specified year.

Changed on

Get pay statement details API will return employee pay statement details data currently available in Web Pay for the specified year.

get/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{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.

dettypesstring

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

amountnumber nullable

.<br />

checkDatestring paylocity-date nullable

.<br />

detstring nullable

.<br />

detCodestring nullable

.<br />

detTypestring nullable

.<br />

eligibleCompensationnumber nullable

.<br />

hoursnumber nullable

.<br />

ratenumber nullable

.<br />

transactionNumberinteger
<br />
transactionTypestring nullable

.<br />

yearinteger

.<br />

Changes