Paylocity
App · 25 actions
Read Paylocity company codes, employees, payroll setup and scheduled shifts.
Actions
| Action | What it does |
|---|---|
| Get company Information | Get company Information. |
| Get employee | Get employee. |
| Get employee Bank Account by ID | Get employee Bank Account by ID. |
| Get employee Bank Accounts | Get employee Bank Accounts. |
| Get employee Deduction | Get employee Deduction. |
| Get employee Deduction by resourceId | Get employee Deduction by resourceId. |
| Get employee Deductions | Get employee Deductions. |
| Get employee Earning | Get employee Earning. |
| Get employee Earnings | Get employee Earnings. |
| Get employee Shifts | Get employee Shifts. |
| Get Job Code | Get Job Code. |
| List company shifts | List company shifts. |
| List cost center codes | List cost center codes. |
| List deduction codes | List deduction codes. |
| List earning codes | List earning codes. |
| List employees | List employees. |
| List job codes | List job codes. |
| List open shifts | List open shifts. |
| List pay frequency codes | List pay frequency codes. |
| List pay grades | List pay grades. |
| List position codes | List position codes. |
| List rate codes | List rate codes. |
| List tax codes | List tax codes. |
| List work locations | List work locations. |
| List workers compensation codes | List workers compensation codes. |
Get company Information
Get company Information. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"accessEndDate": "2026-01-01T00:00:00Z",
"address": {
"country": "example",
"county": "example",
"label": "example",
"line1": "example",
"line2": "example",
"locality": "example",
"mailStopCode": "example",
"postalCode": "example",
"state": "example",
"type": "example"
},
"clientId": 1,
"companyId": "example",
"companyName": "example",
"dba": "example",
"ein": "example",
"endDate": "2026-01-01T00:00:00Z",
"entityType": "example",
"firstCheckDate": "2026-01-01T00:00:00Z",
"industryType": "example",
"naics": 1,
"parentCompanySetId": "example",
"phone": "example",
"relationships": [],
"serviceStartDate": "2026-01-01T00:00:00Z",
"status": "example",
"webTimeCo": "example"
},
"has_more": false,
"next_cursor": "example"
}Get employee
Get employee. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Include
includelistRequired - Include.One or more of:
info,position,status,payrate,futurePayrates.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"companyId": "example",
"currentPayRate": {
"annualSalary": 1,
"baseRate": 1,
"beginCheckDate": "example",
"defaultHours": 1,
"effectiveDate": "2026-01-01T00:00:00Z",
"isAutoPay": false,
"payFrequency": "example",
"payGrade": "example",
"payType": "example",
"ratePer": "example",
"salary": 1
},
"currentStatus": {
"changeReason": "example",
"changeReasonCode": 1,
"effectiveDate": "2026-01-01T00:00:00Z",
"status": "example",
"statusCode": "example",
"statusType": "example"
},
"displayName": "example",
"futurePayRates": [],
"id": "example",
"info": {
"address": {
"address1": "example",
"address2": "example",
"city": "example",
"country": "example",
"county": "example",
"postalCode": "example",
"state": "example"
},
"adjustedSeniorityDate": "2026-01-01T00:00:00Z",
"clockBadge": "example",
"dateOfBirth": "example",
"displayName": "example",
"eeoClass": "example",
"eligibleforRehire": false,
"ethnicityRace": "example",
"firstName": "example",
"gender": "example",
"hireDate": "2026-01-01T00:00:00Z",
"homePhone": "example",
"isSupervisor": false,
"jobTitle": "example",
"lastName": "example",
"maritalStatus": "example",
"middleName": "example",
"minWageExempt": false,
"mobilePhone": "example",
"otExempt": false,
"payGroup": "example",
"personalEmail": "example",
"preferredName": "example",
"reviewer": "example",
"reviewerCo": "example",
"shift": "example",
"ssn": "example",
"suffix": "example",
"supervisor": "example",
"supervisorCo": "example",
"tipped": "example",
"wcc": "example",
"workLocation": {
"address": {},
"email": "example",
"mobilePhone": "example",
"phone": "example",
"phoneExt": "example"
}
},
"lastName": "example",
"position": {
"careerLevelCode": "example",
"careerLevelDescription": "example",
"changeReason": "example",
"costCenter1": "example",
"costCenter2": "example",
"costCenter3": "example",
"effectiveDate": "2026-01-01T00:00:00Z",
"employeeType": "example",
"positionCode": "example",
"positionDescription": "example",
"positionFamilies": []
},
"relationshipId": "example",
"status": "example",
"statusType": "example"
},
"has_more": false,
"next_cursor": "example"
}Get employee Bank Account by ID
Get employee Bank Account by ID. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Bank account id
bank_account_idtextRequired - Bankaccountid.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"accountNumber": "example",
"bankAccountId": "example",
"bankName": "example",
"routingNumber": "example"
},
"has_more": false,
"next_cursor": "example"
}Get employee Bank Accounts
Get employee Bank Accounts. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee Deduction
Get employee Deduction. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Deduction code
deduction_codetextRequired - Deductioncode.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee Deduction by resourceId
Get employee Deduction by resourceId. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Deduction code
deduction_codetextRequired - Deductioncode.
- Resource id
resource_idtextRequired - Resourceid.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"agencyCode": "example",
"arrear": 1,
"beginCheckDate": "2026-01-01T00:00:00Z",
"calculationCode": "example",
"code": "example",
"companyId": "example",
"costCenters": [],
"effectiveDate": "2026-01-01T00:00:00Z",
"employeeId": "example",
"endCheckDate": "2026-01-01T00:00:00Z",
"frequency": "example",
"id": "example",
"limits": {
"annualMaximum": 1,
"goal": 1,
"paidToDate": 1,
"paidYearToDate": 1,
"payPeriodMaximum": 1,
"payPeriodMinimum": 1
},
"loan401K": {
"firstPaymentDate": "2026-01-01T00:00:00Z",
"issueDate": "2026-01-01T00:00:00Z",
"loanNumber": "example"
},
"miscellaneousInfo": "example",
"note": "example",
"priority": 1,
"rate": 1,
"recordType": "Current",
"selfInsured": false,
"type": "example"
},
"has_more": false,
"next_cursor": "example"
}Get employee Deductions
Get employee Deductions. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Filter
filtertext - Filter.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee Earning
Get employee Earning. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Earning code
earning_codetextRequired - Earningcode.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee Earnings
Get employee Earnings. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Filter
filtertext - Filter.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee Shifts
Get employee Shifts. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Employee
employee_idtextRequired - Employeeid.
- Include
includetext - Include.
- Filter
filtertext - Filter.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.From 0 to 2147483647.
- Sort
sorttext - Sort.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get Job Code
Get Job Code. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Job code
job_codetextRequired - Jobcode.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"address": {
"city": "example",
"country": "example",
"county": "example",
"line1": "example",
"line2": "example",
"state": "example",
"zip": "example"
},
"code": "example",
"companyId": "example",
"description": "example",
"isActive": false,
"isCertified": false,
"payEntry": {
"addingRateConstant": 1,
"multiplyingRateConstant": 1,
"rate": 1,
"rateCode": "example",
"shift": "example",
"tax": {
"local1": "example",
"local2": "example",
"local3": "example",
"state": "example"
},
"workerComputedCode": "example"
},
"payrollBasedJournal": {
"facilityId": "example",
"jobTitleCode": "example",
"stateId": "example"
}
},
"has_more": false,
"next_cursor": "example"
}List company shifts
List company shifts. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include
includetext - Include.
- Filter
filtertext - Filter.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.From 0 to 2147483647.
- Sort
sorttext - Sort.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List cost center codes
List cost center codes. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List deduction codes
List deduction codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List earning codes
List earning codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List employees
List employees. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Limit
limitnumber - Limit.From 1 to 20.
- Next page cursor
next_tokentext - Nexttoken.
- Include
includelist - Include.One or more of:
info,position,status,payrate,futurePayrates. - Active only
active_onlytrue/false - Activeonly.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"employees": [],
"totalCount": 1
},
"has_more": false,
"next_cursor": "example"
}List job codes
List job codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Filter
filtertext - Filter.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List open shifts
List open shifts. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include
includetext - Include.
- Filter
filtertext - Filter.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.From 0 to 2147483647.
- Sort
sorttext - Sort.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List pay frequency codes
List pay frequency codes. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List pay grades
List pay grades. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List position codes
List position codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List rate codes
List rate codes. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List tax codes
List tax codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Offset
offsetnumber - Offset.At least 0.
- Limit
limitnumber - Limit.From 1 to 100.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List work locations
List work locations. Returns the service response.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List workers compensation codes
List workers compensation codes. Returns one page; use the next page cursor to continue.
Inputs
- Company ID
company_idtext - Company ID. Leave empty to use the connected company.
- Include total count
include_total_counttrue/false - Includetotalcount.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - Offset.At least 0.
Outputs
datalist- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}