Skip to navigation
Pay Details API Pay Statements

Get Pay Statements by Employee and Date Range

View as Markdown
Retrieves all pay statements for the specified employee within the given date range.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

employeeIdstringRequired
Employee identifier within the specified company.

Headers

testModebooleanOptional
If true, responses are mocked.
AcceptstringOptional

Media type(s) the client can accept in the response (typically application/json).

Query parameters

rangeStartstringOptional

The earliest check date of pay statements to return (YYYY-MM-DD).

rangeEndstringOptional

The latest check date of pay statements to return (YYYY-MM-DD).

includeTotalCountbooleanOptional

If true, includes a total-count header in the response.

limitintegerOptional

Maximum number of items to return. Used together with offset for offset/limit pagination.

offsetintegerOptional
Number of items to skip before collecting the result set.
fieldsstringOptional

Comma-separated list of fields to include.

filterstringOptional

OData-style filter string.

Response headers

X-Pcty-Total-Countinteger

When the request sets includeTotalCount=true, the API returns this header with the total number of resources available (even if only one page is returned).

Response

Successful response

Errors

401
Unauthorized Error