PApaylocity
PayStatements

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 Paylocity Payroll/HR solution for the specified year.

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

Request

  • Base URL
    https://dc1demogw.paylocity.com/api
  • URL
    https://dc1demogw.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

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

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

Auto pay

beginDatestring paylocity-date

Begin date

checkDatestring paylocity-date

Check date

checkNumberinteger

Check number

directDepositAmountnumber

Direct deposit amount

endDatestring paylocity-date

End date

grossPaynumber

Gross pay

hoursnumber

Hours

netChecknumber

Net check

netPaynumber

Net pay

overtimeDollarsnumber

Overtime dollars

overtimeHoursnumber

Overtime hours

processinteger

Process

regularDollarsnumber

Regular dollars

regularHoursnumber

Regular hours

transactionNumbernumber

Transaction number

voucherNumberinteger

Voucher number

workersCompCodestring

Workers comp code

yearinteger

Year

Changes

No recorded changes to this operation across all 1 revision of this API.