---
title: "Upsert Deduction"
method: POST
path: "/v1/deduction"
tags: ["Deduction"]
---

# Upsert Deduction

`POST /v1/deduction`

Upsert Deduction API sends new or updated employee deduction information directly to Paylocity Payroll/HR solution.

## Headers

- `Authorization` string, required

## Request body

- object
  - `deduction` AddUpdateDeduction
    - `agency` string — Used to produce third-party checks for a specific agency. Must match Company setup.<br />Max length: 5
    - `annualMaximum` number — Year to Date dollar amount not to be exceeded for a deduction in the calendar year. <br />Decimal(12,2)
    - `calcCode` string — Defines how deductions are calculated. Common values are *% (percentage of gross), flat (flat dollar amount)*. Defaulted to the Company setup calcCode for deduction. <br />Max length: 15
    - `caseNo` string — Child Support Case Identifier number, case number or court order number.<br />Max length: 20
    - `companyNumber` string — Paylocity assigned company number. <br />Max length: 9
    - `costCenter1` string — Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10
    - `costCenter2` string — Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10
    - `costCenter3` string — Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10
    - `dcode` string — Deduction code. Must match Company setup. <br />Max length: 5
    - `effectiveDate` string, date — Date deduction or benefit is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD
    - `employeeId` string — Either employee ID or employee SSN is required.<br /> Max length: 10
    - `endDate` string, date — Stop date of a deduction or benefit. Common formats are MM-DD-CCYY, CCYY-MM-DD.
    - `fipsCode` string — Child support Federal Information Process Standard (FIPS) code. <br />Max length: 7
    - `frequency` string — Needed if deduction is applied differently from the payroll frequency (one time deduction for example).<br /> Max length: 5
    - `goal` number — Dollar amount. The employee deduction will stop when the goal amount is reached.<br /> Decimal(12,2)
    - `isSelfInsuredPlan` boolean — Used for ACA. If not entered, defaulted to Company deduction setup
    - `loanFirstPaymentDate401K` string, date — 401K loan first payment date. Common formats are MM-DD-CCYY, CCYY-MM-DD
    - `loanIssueDate401K` string, date — 401K loan issue date. Common formats are MM-DD-CCYY, CCYY-MM-DD
    - `loanNumber` string — 401K Loan number, required for 401K Loan deduction types. <br /> Max length: 50
    - `maximum` number — Maximum amount of the deduction on a single paycheck. <br /> Decimal(12,2)
    - `medicalSupport` boolean — Indicates if the employee qualifies for medical benefits that can be used to cover the child
    - `minimum` number — Minimum amount of the deduction on a single paycheck. <br /> Decimal(12,2)
    - `miscInfo` string — Information to print on the check stub if agency check is set up for this deduction. <br />Max length: 50
    - `paidTowardsGoal` number — Amount already paid toward goal.<br /> Decimal(12,2)
    - `priority` integer — Priority of a deduction within the deduction category. Common values are *0,1,2. <br /> Max length: 2
    - `rate` number — Value to match the calcCode (percentage or amount). For example if calcCode = %, enter 10.00 to indicate 10%. <br /> Decimal(12,2)
    - `reportTerminated` boolean — Indicates whether agency needs to be reported on terminated employee
    - `ssn` string — Either employee ID or employee SSN is required.<br /> Max length: 11
    - `startDate` string, date — Start date of a deduction based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD
    - `stateAbbrev` string — State for child support.<br /> Max length: 2

## Response `200`

Successfully processed

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/paylocity/apis/assessments-api.md) · [All operations](https://skmtc.net/paylocity/apis/assessments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paylocity/assessments-api/revisions/dd22ab229153/schema)