API Basics

Authentication
Errors
Filtering
Rate Limits
Webhooks

Assessments API

Assessments Overview
Callback
Order
- Update Assessment orderpatch
Package
Subscription
- Update or create a subscriptionput

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information API

Company Information
- GET a single Company Informationget
Payroll/HR
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Gets a list of employees by company IDget
- Gets a single employee by company and employee IDsget

Partner Onboarding API

Client Onboarding
- Upsert onboarding statusput

Pay Entry API

Pay Entry
- Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Deductions
Earnings

Punch Import API

Punch Import Overview
Punch Import Field Mapping
Punch Import
- Post Employee punch datapost

Retirement contributions Api

Retirement contributions
- Gets Retirement Contributionsget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Local Tax
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

API Basics

Authentication
Errors
Filtering
Rate Limits
Webhooks

Assessments API

Assessments Overview
Callback
Order
- Update Assessment orderpatch
Package
Subscription
- Update or create a subscriptionput

Background Check API

Background Check Overview
Client Onboarding
Subscription
Screening Package
Candidate Screening Order
- Updates the Screening Order statuspatch

Company Level Information API

Company Information
- GET a single Company Informationget
Payroll/HR
Job Codes

Document Management API

Documents Overview
Documents

Employee Demographic API

Employees
- Gets a list of employees by company IDget
- Gets a single employee by company and employee IDsget

Partner Onboarding API

Client Onboarding
- Upsert onboarding statusput

Pay Entry API

Pay Entry
- Create New Payroll Batchpost

Pay Setup API

Pay Setup Overview
Deductions
Earnings

Punch Import API

Punch Import Overview
Punch Import Field Mapping
Punch Import
- Post Employee punch datapost

Retirement contributions Api

Retirement contributions
- Gets Retirement Contributionsget

WebLink API

Authentication
Rate Limits
Deduction
Onboarding
- Add Employee to Onboardingpost
Local Tax
Additional Rates
- Add/update additional ratesput
Client Credentials
- Obtain new client secret.post
Company Codes
- Get All Company Codesget
Company-Specific Schema
- Get Company-Specific Open API Documentationget
Custom Fields
- Get All Custom Fieldsget
Direct Deposit
- Get All Direct Depositget
Earnings
Emergency Contacts
- Add/update emergency contactsput
Employee Benefit Setup
- Add/update employee's benefit setupput
Employee Staging
- Add new employee to Web Linkpost
Employee
Local Taxes
Non-Primary State Tax
- Add/update non-primary state taxput
Pay Rate Searches
- Create an employee pay rates searchpost
PayStatements
Primary State Tax
- Add/update primary state taxput
Sensitive Data
- Get sensitive dataget
- Add/update sensitive dataput
Status Searches
- Create an employee statuses searchpost

Get employee pay statement details data for the specified year and check date.

get https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}/{checkDate}

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.

Path Params

companyId

string

required

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

employeeId

string

required

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

year

string

required

The year for which to retrieve pay statement data

checkDate

string

required

The check date for which to retrieve pay statement data

Query Params

pagesize

integer

Number of records per page. Default value is 25.

pagenumber

integer

Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.

includetotalcount

boolean

Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.

codegroup

string

Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.

Responses

Response body

array of objects

object

amount

number

Amount

checkDate

string

Check date

det

string

Det

detCode

string

Det code

detType

string

Det type

eligibleCompensation

number

Eligible compensation

hours

number

Hours

rate

number

Rate

transactionNumber

number

Transaction number

transactionType

string

Transaction type

year

integer

Year

401

Unauthorized

403

Forbidden

Response body

array of objects

object

field

string

The name of the field, or property in the request message that contains an error.

message

string

The error message.

options

array of objects

A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.

options

object

code

string

The code associated with this option.

description

string

The description of the option.

path

string

The JSON path of the field, or property, that contains an error in the request message.

429

Too Many Requests

Response body

array of objects

object

field

string

The name of the field, or property in the request message that contains an error.

message

string

The error message.

options

array of objects

A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.

options

object

code

string

The code associated with this option.

description

string

The description of the option.

path

string

The JSON path of the field, or property, that contains an error in the request message.

Updated over 1 year ago

Create an employee pay rates search

Get employee pay statement details data for the specified year.

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apisandbox.paylocity.com/api/v2/companies/companyId/employees/employeeId/paystatement/details/year/checkDate \
3
     --header 'accept: application/json'


xxxxxxxxxx
15
 
1
[
2
  {
3
    "amount": 0,
4
    "checkDate": "string",
5
    "det": "string",
6
    "detCode": "string",
7
    "detType": "string",
8
    "eligibleCompensation": 0,
9
    "hours": 0,
10
    "rate": 0,
11
    "transactionNumber": 0,
12
    "transactionType": "string",
13
    "year": 0
14
  }
15
]

Updated over 1 year ago

Create an employee pay rates search

Get employee pay statement details data for the specified year.

Did this page help you?

API Basics
Authentication
Errors
Filtering
Rate Limits
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete callbackdelete
Add or update callbackput
Get callbackget
Order
Update Assessment orderpatch
Package
Get Assessment packagesget
Insert or update Assessment packagesput
Delete Assessment packagedelete
Insert or update Assessment packageput
Subscription
Update or create a subscriptionput

Background Check API
Background Check Overview
Client Onboarding
Updates billing code statuspatch
Delete billing codedelete
Add billing codespost
Upsert onboarding statuspost
Subscription
Deletes the webhookdelete
Register the webhook URL for the subscription of new CandidateScreeningOrderpost
Returns the webhook for the subscription of a new candidate screening orderget
Screening Package
Deletes screening packagedelete
Upserts screening packagepost
Bulk Upsertpost
Returns screening packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information API
Company Information
GET a single Company Informationget
Payroll/HR
GET a List of Pay Grades by Company IDget
GET a List of Position Codes by Company IDget
GET a List of Workers Compensation Codes by Company IDget
GET a list of Tax Codes by Company IDget
GET Pay Frequency Code by list by Company IDget
GET a list of Deduction Codes by Company IDget
GET a List of Earning Codes by Company IDget
GET a list of Cost Centers by Company IDget
GET a list of Rate Codes by Company IDget
GET a list of Work Locations by Company IDget
Job Codes
Filtering Job Codes
Delete a single Job Codedelete
Update a single Job Codeput
GET a single Job Codeget
Create a single Job Codepost
GET a list of Job Codes by Company IDget

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Gets a single employee by company and employee IDsget
Gets a list of employees by company IDget

Partner Onboarding API
Client Onboarding
Upsert onboarding statusput

Pay Entry API
Pay Entry
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Deductions
Filtering Deductions
DELETE Recurring Deduction Code on the Employee Recorddelete
Update Recurring Deduction Details for a specific past/present/future deductionput
GET Recurring Deduction Details for a specific past/present/future deductionget
GET Recurring Deduction Detailget
Create new Recurring Employee Deductionpost
GET Employee Deduction Listget
Earnings
Filtering Earnings
DELETE Recurring Earning Code on the Employee Recorddelete
Update Recurring Earning Details for a specific past/present/future earningput
GET Recurring Earning Details for a specific past/present/future earningget
GET Recurring Earning Detailget
Create new Recurring Employee Earningpost
GET Employee Earnings Listget

Punch Import API
Punch Import Overview
Punch Import Field Mapping
Punch Import
Post Employee punch datapost

Retirement contributions Api
Retirement contributions
Gets Retirement Contributionsget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Local Tax
Add Local Taxpost
Get All Local Taxesget
Delete Local Tax for Tax Codedelete
Update Local Taxput
Get Local Tax for Tax Codeget
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

API Basics
Authentication
Errors
Filtering
Rate Limits
Webhooks
Future Dated Changes
Time Off Approval Webhooks
Payroll Processed Webhooks
Termination Webhooks
Employee Change Webhooks
New Hire Webhooks

Assessments API
Assessments Overview
Callback
Delete callbackdelete
Add or update callbackput
Get callbackget
Order
Update Assessment orderpatch
Package
Get Assessment packagesget
Insert or update Assessment packagesput
Delete Assessment packagedelete
Insert or update Assessment packageput
Subscription
Update or create a subscriptionput

Background Check API
Background Check Overview
Client Onboarding
Updates billing code statuspatch
Delete billing codedelete
Add billing codespost
Upsert onboarding statuspost
Subscription
Deletes the webhookdelete
Register the webhook URL for the subscription of new CandidateScreeningOrderpost
Returns the webhook for the subscription of a new candidate screening orderget
Screening Package
Deletes screening packagedelete
Upserts screening packagepost
Bulk Upsertpost
Returns screening packagesget
Candidate Screening Order
Updates the Screening Order statuspatch

Company Level Information API
Company Information
GET a single Company Informationget
Payroll/HR
GET a List of Pay Grades by Company IDget
GET a List of Position Codes by Company IDget
GET a List of Workers Compensation Codes by Company IDget
GET a list of Tax Codes by Company IDget
GET Pay Frequency Code by list by Company IDget
GET a list of Deduction Codes by Company IDget
GET a List of Earning Codes by Company IDget
GET a list of Cost Centers by Company IDget
GET a list of Rate Codes by Company IDget
GET a list of Work Locations by Company IDget
Job Codes
Filtering Job Codes
Delete a single Job Codedelete
Update a single Job Codeput
GET a single Job Codeget
Create a single Job Codepost
GET a list of Job Codes by Company IDget

Document Management API
Documents Overview
Documents
Retrieve a document download URLpost
Get a list of documents filtered by employee for a companyget
Get a list of documents for a companyget

Employee Demographic API
Employees
Gets a single employee by company and employee IDsget
Gets a list of employees by company IDget

Partner Onboarding API
Client Onboarding
Upsert onboarding statusput

Pay Entry API
Pay Entry
Create New Payroll Batchpost

Pay Setup API
Pay Setup Overview
Deductions
Filtering Deductions
DELETE Recurring Deduction Code on the Employee Recorddelete
Update Recurring Deduction Details for a specific past/present/future deductionput
GET Recurring Deduction Details for a specific past/present/future deductionget
GET Recurring Deduction Detailget
Create new Recurring Employee Deductionpost
GET Employee Deduction Listget
Earnings
Filtering Earnings
DELETE Recurring Earning Code on the Employee Recorddelete
Update Recurring Earning Details for a specific past/present/future earningput
GET Recurring Earning Details for a specific past/present/future earningget
GET Recurring Earning Detailget
Create new Recurring Employee Earningpost
GET Employee Earnings Listget

Punch Import API
Punch Import Overview
Punch Import Field Mapping
Punch Import
Post Employee punch datapost

Retirement contributions Api
Retirement contributions
Gets Retirement Contributionsget

WebLink API
Authentication
Rate Limits
Deduction
Get Deduction for Deduction Codeget
Get All Deductionsget
Delete deduction for deduction code / start datedelete
Add / Update Deductionpost
Onboarding
Add Employee to Onboardingpost
Local Tax
Add Local Taxpost
Get All Local Taxesget
Delete Local Tax for Tax Codedelete
Update Local Taxput
Get Local Tax for Tax Codeget
Additional Rates
Add/update additional ratesput
Client Credentials
Obtain new client secret.post
Company Codes
Get All Company Codesget
Company-Specific Schema
Get Company-Specific Open API Documentationget
Custom Fields
Get All Custom Fieldsget
Direct Deposit
Get All Direct Depositget
Earnings
Get Earnings by Earning Codeget
Delete Earning by Earning Code and Start Datedelete
Get Earning by Earning Code and Start Dateget
Add/Update Earningput
Get All Earningsget
Emergency Contacts
Add/update emergency contactsput
Employee Benefit Setup
Add/update employee's benefit setupput
Employee Staging
Add new employee to Web Linkpost
Employee
Update employeepatch
Get employeeget
Add new employeepost
Get all employeesget
Local Taxes
Delete local tax by tax codedelete
Get local taxes by tax codeget
Add new local taxpost
Get all local taxesget
Non-Primary State Tax
Add/update non-primary state taxput
Pay Rate Searches
Create an employee pay rates searchpost
PayStatements
Get employee pay statement summary data for the specified year.get
Get employee pay statement summary data for the specified year and check date.get
Get employee pay statement details data for the specified year.get
Get employee pay statement details data for the specified year and check date.get
Primary State Tax
Add/update primary state taxput
Sensitive Data
Add/update sensitive dataput
Get sensitive dataget
Status Searches
Create an employee statuses searchpost

200Successfully Retrieved

404The employee, specified year, or check date does not exist

500Internal Server Error