Payroll systems · Paylocity
Paylocity Web Pay
Paylocity's own documentation covers employees, pay statements, deduction write, bank account write, hours and webhooks through the API. Access: Customer or approved partner.
Integration method grade A · field-level docs publicly readable · last verified 2026-09-10 · Pay Setup — Deductions & Earnings
What the API lets you do
| Question | Answer | Conf | What the documentation says |
|---|---|---|---|
| How do you get API access? | Customer or approved partner | D | Demo access requires being a Paylocity customer or having a customer willing to take part in early-adoption testing; Paylocity then issues OAuth credentials. Source |
| Can you read employees and pay rates? | Yes — REST read and write | D | GET /v2/companies/{companyId}/employees/{employeeId} returns names, departmentPosition.jobTitle, status.hireDate and primaryPayRate.baseRate/salary. Source |
| Can you read pay statements? | Yes — detail + summary | D | Pay statement detail by year and check date returns det, detCode, amount, hours and rate. The newer Pay Details API requires a Technology Partnership Agreement. Source |
| Can you write a deduction? | Yes — Upsert Deduction | D | POST /v1/deduction sends new or updated deductions with code, calculation method, rates and dates. Source |
| Can you write a direct deposit account? | Yes — via Update Employee | D | PATCH employee accepts mainDirectDeposit and additionalDirectDeposit; an update replaces all existing direct deposits. Source |
| Can you read W-2s? | Unverified | U | No W-2 or tax-document endpoint in the developer portal index; only tax setup endpoints. |
| Can you read hours worked? | Yes — punch detail | D | GET /apihub/time/v2/companies/{companyId}/employees/{employeeId}/punchdetails returns work and non-work punch data. Source |
| Does it push change events? | Yes — configured by Paylocity | D | New Hire, Employee Change, Termination, Payroll Processed and Time Off Approval events; Paylocity support configures the receiving URL. Source |
| How does an integration authenticate? | OAuth 2.0 client credentials | D | POST /public/security/v1/token with client_credentials; tokens expire after 3600 seconds. Source |
Deduction write, in detail
For benefits, HSA/FSA and 401(k) integrations. 3 of 10 fields are unverified — no public source states the answer. Compare every system on the deduction write detail page.
| Field | Value | Conf | Note — and what a correct answer needed |
|---|---|---|---|
| Deduction read | Yes — API | D | GET company deduction and earning codes, and GET employee deductions and earnings including past, present and future records. |
| Deduction write | API | D | The Pay Setup API documents creating, retrieving, updating and deleting recurring deductions on an employee record — with the stated qualifier "in certain situations", which the docs do not enumerate. |
| Pre-tax vs post-tax at write | Inherited, not assertable | D | No pre-tax or post-tax field exists on DeductionCodeDto. Tax treatment is a property of the company-level detType — HSA EE 125 Pretax Contribution and HSA EE Post Tax Contribution are separate types — so the write selects a code someone already classified. |
| Amount vs percent | Both — explicit | D | calculationCode selects Flat Amount, Percentage of Gross, Percentage of Net (gross minus taxes minus codes in the net code group), Garnishment, or Configurable Garnishment. Separate amount and rate fields; clamped by payPeriodMinimum, payPeriodMaximum and annualMaximum. |
| Effective dating | Yes — three distinct dates | D | Effective Date drives reporting. Start Date / Begin Check Date is the first check date actually affected and determines whether a record is Historical, Current or Future Dated. End Date is the last check date processed. Collapsing these into one start date is a silent off-by-one-pay-period bug. |
| Retro adjustment | Unverified | U | Goal, PaidToDate and PaidYearToDate describe forward accumulation toward a lifetime limit. Nothing documents correcting a deduction for a period that already ran. |
| Employer contribution | Modelled as memo earnings | D | Not a deduction-side object. "Memo: Employer Match" is used automatically for retirement match codes such as 401ER, and HSA Employer Contribution is a separate earning type. Memo earnings bypass tax calculation and do not affect net pay. |
| Code taxonomy shape | Company-defined | D | Each company defines its own codes. Category D / E / T paired with a detType that determines payroll treatment; 40 standard deduction types and 26 earning types. Docs instruct discovery via GET rather than hardcoding, and advise iterating loan codes (401L1 to 401L2) rather than recycling. |
| Auth model | Unverified | U | Not assessed. Paylocity documents auth separately and we have not read it. |
| Data freshness | Unverified | U | No latency or batch cadence stated in the Pay Setup documentation. |
D vendor-documented · U unverified · — not offered. See every payroll system side by side in the Payroll API Capability Matrix.