For general questions and support of the API, contact: webservices@paylocity.com # Overview Paylocity Web Services API is an externally facing RESTful Internet protocol. The Paylocity API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON. Paylocity supports v1 and v2 versions of its API endpoi
codeResource(path, required) — Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions.
GET
/v2/companies/{companyId}/customfields/{category}
Get All Custom Fields
companyId(path, required) — Company Id
category(path, required) — Custom Fields Category
POST
/v2/companies/{companyId}/employees
Add new employee
companyId(path, required) — Company Id
GET
/v2/companies/{companyId}/employees/
Get all employees
companyId(path, required) — Company Id
pagesize(query, limit) — Number of records per page. Default value is 25.
pagenumber(query, page) — 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(query) — Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
Get employee pay statement details data for the specified year.
companyId(path, required) — Company Id
employeeId(path, required) — Employee Id
year(path, required) — The year for which to retrieve pay statement data
pagesize(query, limit) — Number of records per page. Default value is 25.
pagenumber(query, page) — 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(query) — Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
codegroup(query) — Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Get employee pay statement details data for the specified year and check date.
companyId(path, required) — Company Id
employeeId(path, required) — Employee Id
year(path, required) — The year for which to retrieve pay statement data
checkDate(path, required) — The check date for which to retrieve pay statement data
pagesize(query, limit) — Number of records per page. Default value is 25.
pagenumber(query, page) — 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(query) — Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
codegroup(query) — Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Get employee pay statement summary data for the specified year.
companyId(path, required) — Company Id
employeeId(path, required) — Employee Id
year(path, required) — The year for which to retrieve pay statement data
pagesize(query, limit) — Number of records per page. Default value is 25.
pagenumber(query, page) — 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(query) — Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
codegroup(query) — Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Get employee pay statement summary data for the specified year and check date.
companyId(path, required) — Company Id
employeeId(path, required) — Employee Id
year(path, required) — The year for which to retrieve pay statement data
checkDate(path, required) — The check date for which to retrieve pay statement data
pagesize(query, limit) — Number of records per page. Default value is 25.
pagenumber(query, page) — 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(query) — Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
codegroup(query) — Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
