Create Employee Deduction | Paylocity

curl -X POST https://api.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/deductions \
     -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>",
    "ea59": {}
  },
  "costCenters": [
    {
      "level": "<integer>",
      "code": "<string>",
      "commodo4f0": {},
      "ea6": {},
      "sed_9e8": {},
      "esse9": {}
    },
    {
      "level": "<integer>",
      "code": "<string>",
      "amete": {}
    }
  ],
  "limits": {
    "goal": "<double>",
    "paidToDate": "<double>",
    "payPeriodMinimum": "<double>",
    "payPeriodMaximum": "<double>",
    "annualMaximum": "<double>"
  },
  "code": "<string>"
}'

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.

Authentication

AuthorizationBearer

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

Path parameters

companyIdstringRequired

employeeIdstringRequired

Request

This endpoint expects an object.

Response

Successful response