v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Pay Statements

Get Pay Statements by Employee and Date Range

🚧 Partner Restricted

This endpoint is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

Summary Description

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

get/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/payStatements

Path parameters

companyIdstring required

The Paylocity Company Identifier.

employeeIdstring required

The Employee Identifier.

Query parameters

rangeStartstring

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

rangeEndstring

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

includeTotalCountboolean

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

limitinteger

Maximum number of items to return.

offsetinteger

Number of items to skip before collecting the result set.

fieldsstring

Comma-separated list of fields to include.

filterstring

OData-style filter string.

agencyCheckProcessIdinteger

The Agency Check Process ID for filtering pay statements.

Headers

testModeboolean

If true, responses are mocked.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

payStatementIdstring uuid nullable

Unique identifier of the pay statement.

Format: GUID.