Recurring Deductions

Create Employee Deduction

Summary Description

This function will allow the API user to create a new deduction on the employee record. Garnishments cannot be created using the Deduction endpoints.

post/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions

Request

Base URL
dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
URL
dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions
Auth
none declared

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

employeeIdstring required

A filter to use to limit results to a specific employee. Allowable Values: 255 char max

Request body

codestring nullable

Deduction Code

effectiveFromstring date-time nullable

Effective Date of the Deduction

effectiveTostring date-time nullable

End Date of the Deduction

calculationCodestring nullable

Calculation Code that Applies to Deduction

ratenumber double nullable

Rate for the Deduction

frequencystring nullable

Frequency determines how often the deduction Rate is applied in payroll

agencystring nullable

Agency Code. These are custom per client

arrearnumber double nullable

Money that is owed

miscellaneousInfostring nullable

Miscellaneous Information

notestring nullable

Deduction Notes

selfInsuredboolean nullable

Self-Insured Plan Flag. This will generate Part III of the employee's 1095-C Form

priorityinteger nullable

Priority determines the order in which a deduction is subtracted from gross pay. Priorities 1-4 are reserved for Statutory deductions(necessary by law), while 5-7 are reserved for Voluntary deductions(employee-elected).

Response

Created

idstring uuid

Resource ID of the record.