Paylocity Connector

Paylocity provides a comprehensive product suite and delivers a unified platform for the areas of benefits, core HR, payroll, talent, and workforce management. Use the Paylocity component to connect your workforce management, payroll, and other HR tasks with a variety of applications.

Connections

Pay Entry OAuth 2.0

Authenticate requests to Paylocity using values obtained from the developer console.

Input	Comments	Default
Environment	The environment to use for the Paylocity apis
Token URL	Select the environment to fetch the token from.
Client ID	Provide the Client Id you received from the Paylocity Developer Console.
Client Secret	Provide the Client Secret you received from the Paylocity Developer Console.

Paylocity OAuth 2.0

Authenticate requests to Paylocity using values obtained from the developer console.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Environment	The environment to use for the Paylocity apis
Token URL	Select the environment to fetch the token from.
Client ID	Provide the Client Id you received from the Paylocity Developer Console.
Client Secret	Provide the Client Secret you received from the Paylocity Developer Console.

Actions

Create Employee

New Employee API sends new employee data directly to Web Pay.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
First Name	The first name of the employee.
Last Name	The last name of the employee.
Employee	The employee to create or update.	{ "additionalDirectDeposit": [ { "accountNumber": null, "accountType": null, "amount": null, "amountType": null, "blockSpecial": null, "isSkipPreNote": null, "nameOnAccount": null, "preNoteDate": null, "routingNumber": null } ], "additionalRate": [ { "changeReason": null, "costCenter1": null, "costCenter2": null, "costCenter3": null, "effectiveDate": null, "endCheckDate": null, "job": null, "rate": null, "rateCode": null, "rateNotes": null, "ratePer": null, "shift": null } ], "benefitSetup": { "benefitClass": null, "benefitClassEffectiveDate": null, "benefitSalary": null, "benefitSalaryEffectiveDate": null, "doNotApplyAdministrativePeriod": null, "isMeasureAcaEligibility": null }, "birthDate": null, "companyFEIN": null, "companyName": null, "currency": null, "customBooleanFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customDateFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customDropDownFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customNumberFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customTextFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "departmentPosition": { "changeReason": null, "clockBadgeNumber": null, "costCenter1": null, "costCenter2": null, "costCenter3": null, "effectiveDate": null, "employeeType": null, "equalEmploymentOpportunityClass": null, "isMinimumWageExempt": null, "isOvertimeExempt": null, "isSupervisorReviewer": null, "isUnionDuesCollected": null, "isUnionInitiationCollected": null, "jobTitle": null, "payGroup": null, "positionCode": null, "reviewerCompanyNumber": null, "reviewerEmployeeId": null, "shift": null, "supervisorCompanyNumber": null, "supervisorEmployeeId": null, "tipped": null, "unionAffiliationDate": null, "unionCode": null, "unionPosition": null, "workersCompensation": null }, "disabilityDescription": null, "emergencyContacts": [ { "address1": null, "address2": null, "city": null, "country": null, "county": null, "email": null, "firstName": null, "homePhone": null, "lastName": null, "mobilePhone": null, "notes": null, "pager": null, "primaryPhone": null, "priority": null, "relationship": null, "state": null, "syncEmployeeInfo": true, "workExtension": null, "workPhone": null, "zip": null } ], "employeeId": null, "ethnicity": null, "federalTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "taxCalculationCode": null, "w4FormYear": 0 }, "gender": null, "homeAddress": { "address1": null, "address2": null, "city": null, "country": null, "county": null, "emailAddress": null, "mobilePhone": null, "phone": null, "postalCode": null, "state": null }, "isHighlyCompensated": true, "isSmoker": true, "localTax": [ { "exemptions": null, "exemptions2": null, "filingStatus": null, "residentPSD": null, "taxCode": null, "workPSD": null } ], "mainDirectDeposit": { "accountNumber": null, "accountType": null, "blockSpecial": null, "isSkipPreNote": null, "nameOnAccount": null, "preNoteDate": null, "routingNumber": null }, "maritalStatus": null, "middleName": null, "nonPrimaryStateTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "exemptions2": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "reciprocityCode": null, "specialCheckCalc": null, "taxCalculationCode": null, "taxCode": null, "w4FormYear": 0 }, "ownerPercent": null, "preferredName": null, "primaryPayRate": { "annualSalary": null, "baseRate": null, "beginCheckDate": null, "changeReason": null, "defaultHours": null, "effectiveDate": null, "isAutoPay": null, "payFrequency": null, "payGrade": null, "payRateNote": null, "payType": null, "ratePer": null, "salary": null }, "primaryStateTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "exemptions2": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "specialCheckCalc": null, "taxCalculationCode": null, "taxCode": null, "w4FormYear": 0 }, "priorLastName": null, "salutation": null, "ssn": null, "status": { "adjustedSeniorityDate": null, "changeReason": null, "effectiveDate": null, "employeeStatus": null, "hireDate": null, "isEligibleForRehire": null, "reHireDate": null, "statusType": null, "terminationDate": null }, "suffix": null, "taxSetup": { "fitwExemptNotes": null, "fitwExemptReason": null, "futaExemptNotes": null, "futaExemptReason": null, "isEmployee943": true, "isPension": true, "isStatutory": true, "medExemptNotes": null, "medExemptReason": null, "sitwExemptNotes": null, "sitwExemptReason": null, "ssExemptNotes": null, "ssExemptReason": null, "suiExemptNotes": null, "suiExemptReason": null, "suiState": null, "taxDistributionCode1099R": null, "taxForm": null }, "veteranDescription": null, "webTime": { "badgeNumber": null, "chargeRate": null, "isTimeLaborEnabled": null }, "workAddress": { "address1": null, "address2": null, "city": null, "country": null, "county": null, "emailAddress": null, "location": null, "mailStop": null, "mobilePhone": null, "pager": null, "phone": null, "phoneExtension": null, "postalCode": null, "state": null }, "workEligibility": { "alienOrAdmissionDocumentNumber": null, "attestedDate": null, "countryOfIssuance": null, "foreignPassportNumber": null, "i94AdmissionNumber": null, "i9DateVerified": null, "i9Notes": null, "isI9Verified": null, "isSsnVerified": null, "ssnDateVerified": null, "ssnNotes": null, "visaType": null, "workAuthorization": null, "workUntil": null } }

Create Pay Entry

Create a new Pay Entry Import

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
File	The file to upload.
File Name	The name of the file to upload.
Pay Entry Input	The pay entry fields to create or update	{ "AutoAcknowledge": false, "Batch": { "BatchName": "string", "MergeBatchId": 123 }, "Calendar": { "CalendarId": 123, "PayPeriodBeginDate": "2021-01-01", "PayPeriodEndDate": "2021-01-01", "CheckDate": "2021-01-01" } }

Create/Update Earning

Create/Update Earning API sends new or updated employee earnings information directly to Web Pay.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Employee ID	The id of the employee to retrieve.
Earning Code	The earning code of the employee.
Start Date	The start date of the employee.
Earnings Input	The earnings to create or update.	{ "agency": null, "amount": null, "annualMaximum": null, "calculationCode": null, "costCenter1": null, "costCenter2": null, "costCenter3": null, "effectiveDate": null, "endDate": null, "frequency": null, "goal": null, "hoursOrUnits": null, "isSelfInsured": null, "jobCode": null, "miscellaneousInfo": null, "paidTowardsGoal": null, "payPeriodMaximum": null, "payPeriodMinimum": null, "rate": null, "rateCode": null }

Delete Earnings by Earning Code and Start Date

Delete Earning by Earning Code and Start Date

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Employee ID	The id of the employee to retrieve.
Earning Code	The earning code of the employee.
Start Date	The start date of the employee.

Download Document

Download a document by ID

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Document ID	The id of the document to download.

Get Company Documents

Retrieve Company Documents by Company ID

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Include Total Count	Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].	false
Limit	Defines the maximum number of items to be returned in the response.
Offset	Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.

Get Company Specific Schema

The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.

Get Earnings by Earning Code and Start Date

Get Earnings returns the single earning with the provided earning code and start date for the selected employee.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Employee ID	The id of the employee to retrieve.
Earning Code	The earning code of the employee.
Start Date	The start date of the employee.

Get Employee

Get Employee API will return employee data currently available in Web Pay.

Input	Comments	Default
Connection
Employee ID	The id of the employee to retrieve.
Company ID	The id of the company to retrieve.

Get Employee Documents

Retrieve Employee Documents by Company ID

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Include Total Count	Requests that the response include the Pcty-Total-Count header containing the total number of objects that match the request. This may be useful if requesting a small [limit].	false
Limit	Defines the maximum number of items to be returned in the response.
Offset	Defines the start location to return. Ex. offset=100 means starting at item 100, return the next [limit] items.

Get New Client Secret

Obtain new client secret for Paylocity-issued client id.

Input	Comments	Default
Connection
Code	A value sent with the 'ACTION NEEDED: Web Link API Credentials Expiring Soon.' email notification.

Get Pay Entry

Retrieve a Pay Entry Import

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Time Import File Tracking ID	The tracking id of the time import file to retrieve.

List Company Codes

Get All Company Codes for the selected company and resource.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Code Resource	Type of Company Code.

List Custom Fields

Get All Custom Fields for the selected company

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Category	Custom Fields Category

List Earnings

Get All Earnings returns all earnings for the selected employee.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Employee ID	The id of the employee to retrieve.

List Employees

Get All Employees API will return employee data currently available in Web Pay.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Page Size	Number of records per page. Default value is 25. Max value is 5000. Leave blank to fetch all records.	25
Page Number	Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.	0
Include Total Count	Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.	false

Raw Request

Send raw HTTP request to Paylocity

Input	Comments	Default
Connection
URL	Input the path only (/companies/{companyId}/employees/{employeeId}/additionalRates), The base URL is already included (https://api.paylocity.com/api/v2). For example, to connect to https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates, only /companies/{companyId}/employees/{employeeId}/additionalRates is entered in this field.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Update Employee

Update Employee API will update existing employee data in WebPay.

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
Employee ID	The id of the employee to retrieve.
First Name	The first name of the employee.
Last Name	The last name of the employee.
Employee	The employee to create or update.	{ "additionalDirectDeposit": [ { "accountNumber": null, "accountType": null, "amount": null, "amountType": null, "blockSpecial": null, "isSkipPreNote": null, "nameOnAccount": null, "preNoteDate": null, "routingNumber": null } ], "additionalRate": [ { "changeReason": null, "costCenter1": null, "costCenter2": null, "costCenter3": null, "effectiveDate": null, "endCheckDate": null, "job": null, "rate": null, "rateCode": null, "rateNotes": null, "ratePer": null, "shift": null } ], "benefitSetup": { "benefitClass": null, "benefitClassEffectiveDate": null, "benefitSalary": null, "benefitSalaryEffectiveDate": null, "doNotApplyAdministrativePeriod": null, "isMeasureAcaEligibility": null }, "birthDate": null, "companyFEIN": null, "companyName": null, "currency": null, "customBooleanFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customDateFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customDropDownFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customNumberFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "customTextFields": [ { "category": "PayrollAndHR", "label": null, "value": null } ], "departmentPosition": { "changeReason": null, "clockBadgeNumber": null, "costCenter1": null, "costCenter2": null, "costCenter3": null, "effectiveDate": null, "employeeType": null, "equalEmploymentOpportunityClass": null, "isMinimumWageExempt": null, "isOvertimeExempt": null, "isSupervisorReviewer": null, "isUnionDuesCollected": null, "isUnionInitiationCollected": null, "jobTitle": null, "payGroup": null, "positionCode": null, "reviewerCompanyNumber": null, "reviewerEmployeeId": null, "shift": null, "supervisorCompanyNumber": null, "supervisorEmployeeId": null, "tipped": null, "unionAffiliationDate": null, "unionCode": null, "unionPosition": null, "workersCompensation": null }, "disabilityDescription": null, "emergencyContacts": [ { "address1": null, "address2": null, "city": null, "country": null, "county": null, "email": null, "firstName": null, "homePhone": null, "lastName": null, "mobilePhone": null, "notes": null, "pager": null, "primaryPhone": null, "priority": null, "relationship": null, "state": null, "syncEmployeeInfo": true, "workExtension": null, "workPhone": null, "zip": null } ], "employeeId": null, "ethnicity": null, "federalTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "taxCalculationCode": null, "w4FormYear": 0 }, "gender": null, "homeAddress": { "address1": null, "address2": null, "city": null, "country": null, "county": null, "emailAddress": null, "mobilePhone": null, "phone": null, "postalCode": null, "state": null }, "isHighlyCompensated": true, "isSmoker": true, "localTax": [ { "exemptions": null, "exemptions2": null, "filingStatus": null, "residentPSD": null, "taxCode": null, "workPSD": null } ], "mainDirectDeposit": { "accountNumber": null, "accountType": null, "blockSpecial": null, "isSkipPreNote": null, "nameOnAccount": null, "preNoteDate": null, "routingNumber": null }, "maritalStatus": null, "middleName": null, "nonPrimaryStateTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "exemptions2": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "reciprocityCode": null, "specialCheckCalc": null, "taxCalculationCode": null, "taxCode": null, "w4FormYear": 0 }, "ownerPercent": null, "preferredName": null, "primaryPayRate": { "annualSalary": null, "baseRate": null, "beginCheckDate": null, "changeReason": null, "defaultHours": null, "effectiveDate": null, "isAutoPay": null, "payFrequency": null, "payGrade": null, "payRateNote": null, "payType": null, "ratePer": null, "salary": null }, "primaryStateTax": { "amount": null, "deductionsAmount": 0, "dependentsAmount": 0, "exemptions": null, "exemptions2": null, "filingStatus": null, "higherRate": true, "otherIncomeAmount": 0, "percentage": null, "specialCheckCalc": null, "taxCalculationCode": null, "taxCode": null, "w4FormYear": 0 }, "priorLastName": null, "salutation": null, "ssn": null, "status": { "adjustedSeniorityDate": null, "changeReason": null, "effectiveDate": null, "employeeStatus": null, "hireDate": null, "isEligibleForRehire": null, "reHireDate": null, "statusType": null, "terminationDate": null }, "suffix": null, "taxSetup": { "fitwExemptNotes": null, "fitwExemptReason": null, "futaExemptNotes": null, "futaExemptReason": null, "isEmployee943": true, "isPension": true, "isStatutory": true, "medExemptNotes": null, "medExemptReason": null, "sitwExemptNotes": null, "sitwExemptReason": null, "ssExemptNotes": null, "ssExemptReason": null, "suiExemptNotes": null, "suiExemptReason": null, "suiState": null, "taxDistributionCode1099R": null, "taxForm": null }, "veteranDescription": null, "webTime": { "badgeNumber": null, "chargeRate": null, "isTimeLaborEnabled": null }, "workAddress": { "address1": null, "address2": null, "city": null, "country": null, "county": null, "emailAddress": null, "location": null, "mailStop": null, "mobilePhone": null, "pager": null, "phone": null, "phoneExtension": null, "postalCode": null, "state": null }, "workEligibility": { "alienOrAdmissionDocumentNumber": null, "attestedDate": null, "countryOfIssuance": null, "foreignPassportNumber": null, "i94AdmissionNumber": null, "i9DateVerified": null, "i9Notes": null, "isI9Verified": null, "isSsnVerified": null, "ssnDateVerified": null, "ssnNotes": null, "visaType": null, "workAuthorization": null, "workUntil": null } }

Update Pay Entry

Update an Pay Entry Import

Input	Comments	Default
Connection
Company ID	The id of the company to retrieve.
File	The file to upload.
File Name	The name of the file to upload.
Time Import File Tracking ID	The tracking id of the time import file to retrieve.
Pay Entry Input	The pay entry fields to create or update	{ "AutoAcknowledge": false, "Batch": { "BatchName": "string", "MergeBatchId": 123 }, "Calendar": { "CalendarId": 123, "PayPeriodBeginDate": "2021-01-01", "PayPeriodEndDate": "2021-01-01", "CheckDate": "2021-01-01" } }