Update Recurring Deduction Details for a specific past/present/future deduction

put https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{resourceId}

Summary Description

This function will allow the API user to update details for a particular deduction code that occurs in the past/present/future. Garnishments cannot be updated using the Deduction endpoints.

Path Params

companyId

string

required

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

employeeId

string

required

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

deductionCode

string

required

Deduction Code

resourceId

uuid

required

Resource ID of the record

Body Params

A Payroll Deduction code is a unique identifier used by payroll systems to categorize and track specific deductions from an employee's paycheck. These deductions can include taxes, health insurance premiums, retirement contributions, loan repayments, and more. Each type of deduction has its own unique code that allows it to be easily identified and processed by the payroll system. This not only ensures accurate calculations and disbursements, but also helps with record-keeping and reporting requirements.

effectiveFrom

date-time | null

Effective Date of the Deduction

effectiveTo

date-time | null

End Date of the Deduction

calculationCode

string | null

Calculation Code that Applies to Deduction

rate

double | null

Rate for the Deduction

frequency

string | null

Frequency determines how often the deduction Rate is applied in payroll

agency

string | null

Agency Code. These are custom per client

arrear

double | null

Money that is owed

miscellaneousInfo

string | null

Miscellaneous Information

note

string | null

Deduction Notes

selfInsured

boolean | null

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

priority

int32 | null

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).

loan401K

object

A 401K loan is a type of loan that allows you to borrow money against the balance of your 401K retirement plan, up to a certain limit. It's a way for individuals to access their retirement savings without incurring early withdrawal penalties or taxes. The borrower is expected to repay the loan, typically over five years, through payroll deductions. The values to insert a loan, like Loan Number, and First Payment Date are provided by the record keeper.

costCenters

array of objects | null

An array of objects representing the Cost Centers

costCenters

limits

object

Limits are used to control the amount of an earning or deduction

Headers

Authorization

string

Authorization token. Ex. Bearer ...

Response

200

Success

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/deductions/deductionCode/resourceId \
3
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here!