Upsert Employee Deduction by resourceId | Paylocity

curl -X PUT https://api.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/deductions/deductionCode/resourceId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "effectiveFrom": "<dateTime>",
  "effectiveTo": "<dateTime>",
  "calculationCode": "<string>",
  "rate": "<double>",
  "frequency": "<string>",
  "agency": "<string>",
  "arrear": "<double>",
  "miscellaneousInfo": "<string>",
  "note": "<string>",
  "selfInsured": "<boolean>",
  "priority": "<integer>",
  "loan401K": {
    "loanNumber": "<string>",
    "issueDate": "<dateTime>",
    "firstPaymentDate": "<dateTime>"
  },
  "costCenters": [
    {
      "level": "<integer>",
      "code": "<string>",
      "id_c77": {}
    },
    {
      "level": "<integer>",
      "code": "<string>"
    }
  ],
  "limits": {
    "goal": "<double>",
    "paidToDate": "<double>",
    "payPeriodMinimum": "<double>",
    "payPeriodMaximum": "<double>",
    "annualMaximum": "<double>"
  }
}'

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

employeeIdstringRequired

Employee identifier within the specified company.

deductionCodestringRequired

Deduction code for the employee.

resourceIdstringRequired

Resource instance identifier (deduction/earning line id or related key, depending on the endpoint).

Request

Request payload for this operation. See the official endpoint documentation for required fields and allowable values.

Response

Successful response

Errors

401

Unauthorized Error