Skip to navigation
Pay Details API Pay Statements

Get Pay Statement by ID

View as Markdown
Retrieves the details of a single pay statement by its ID.

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.
payStatementIdstringRequired
Pay statement identifier.

Headers

testModebooleanOptional
If true, responses are mocked.
AcceptstringOptional

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

Query parameters

fieldsstringOptional

Comma-separated list of fields to include.

Response

Successful response

Errors

401
Unauthorized Error