Paylocity

Paylocity is a cloud payroll and human resources platform for managing employee pay, benefits, time, and workforce administration.

• Base URL: https://api.paylocity.com/api
• Auth: OAuth 2.0 client-credentials — the tool fetches a token from https://api.paylocity.com/IdentityServer/connect/token using your clientId/clientSecret, then calls the API.

Operations

• get_all_company_codes_and_descriptions_by_resour — GET /v2/companies/{companyId}/codes/{codeResource} — Get All Company Codes
• get_all_custom_fields_by_category — GET /v2/companies/{companyId}/customfields/{category} — Get All Custom Fields
• get_all_employees — GET /v2/companies/{companyId}/employees/ — Get all employees
• get_employee — GET /v2/companies/{companyId}/employees/{employeeId} — Get employee
• get_all_direct_deposit — GET /v2/companies/{companyId}/employees/{employeeId}/directDeposit — Get All Direct Deposit
• get_all_earnings — GET /v2/companies/{companyId}/employees/{employeeId}/earnings — Get All Earnings

Inputs

• clientId / clientSecret — your paylocity OAuth app credentials
• scope — OAuth scopes (optional; defaults from the spec)
• operation — one of the operations above
• path parameters when an operation's path contains {...}
• query — optional JSON object of query params
• body — JSON object for create/update ops

Example

operation: get_all_company_codes_and_descriptions_by_resour
clientId: <your client id>
clientSecret: <your client secret>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• operation
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.