v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
PayStatements

Get Employee Pay Statement Details Data for the Specified Year and Check Date

Get pay statement details API will return employee pay statement detail data currently available in Paylocity Payroll/HR solution for the specified year and check date.

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

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

employeeIdstring required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max

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.

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

amountnumber

Amount

checkDatestring paylocity-date

Check date

detstring

Det

detCodestring

Det code

detTypestring

Det type

eligibleCompensationnumber

Eligible compensation

hoursnumber

Hours

ratenumber

Rate

transactionNumbernumber

Transaction number

transactionTypestring

Transaction type

yearinteger

Year