Get Deduction for Deduction Code

get https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}

Get Deduction for Deduction Code returns records for a specific deduction for the selected employee.

Responses

Response body

object

agency

string

Used to produce third-party checks for a specific agency. Must match Company setup.
Max length: 5

annualMaximum

number

Year to Date dollar amount not to be exceeded for a deduction in the calendar year.
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.
Max length: 15

caseNo

string

Child Support Case Identifier number, case number or court order number.
Max length: 20

costCenter1

string

Cost Center associated with deduction. Must match Company setup.
Max length: 10

costCenter2

string

Cost Center associated with deduction. Must match Company setup.
Max length: 10

costCenter3

string

Cost Center associated with deduction. Must match Company setup.
Max length: 10

dcode

string

Deduction code. Must match Company setup.
Max length: 5

effectiveDate

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

endDate

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.
Max length: 7

frequency

string

Needed if deduction is applied differently from the payroll frequency (one time deduction for example).
Max length: 5

goal

number

Dollar amount. The employee deduction will stop when the goal amount is reached.
Decimal(12,2)

isSelfInsuredPlan

boolean

Used for ACA. If not entered, defaulted to Company deduction setup

loanFirstPaymentDate401K

date

401K loan first payment date. Common formats are MM-DD-CCYY, CCYY-MM-DD

loanIssueDate401K

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.
Max length: 50

maximum

number

Maximum amount of the deduction on a single paycheck.
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.
Decimal(12,2)

miscInfo

string

Information to print on the check stub if agency check is set up for this deduction.
Max length: 50

paidTowardsGoal

number

Amount already paid toward goal.
Decimal(12,2)

priority

integer

Priority of a deduction within the deduction category. Common values are *0,1,2.
Max length: 2

rate

number

Value to match the calcCode (percentage or amount). For example if calcCode = %, enter 10.00 to indicate 10%.
Decimal(12,2)

reportTerminated

boolean

Indicates whether agency needs to be reported on terminated employee

startDate

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.
Max length: 2

403

Forbidden

404

Not Found

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apisandbox.paylocity.com/api/v1/companies/companyId/employees/employeeId/deductions/deductionCode \
3
     --header 'accept: application/json'


xxxxxxxxxx
29
}
1
{
2
  "agency": "string",
3
  "annualMaximum": 0,
4
  "calcCode": "string",
5
  "caseNo": "string",
6
  "costCenter1": "string",
7
  "costCenter2": "string",
8
  "costCenter3": "string",
9
  "dcode": "string",
10
  "effectiveDate": "2025-04-06",
11
  "endDate": "2025-04-06",
12
  "fipsCode": "string",
13
  "frequency": "string",
14
  "goal": 0,
15
  "isSelfInsuredPlan": true,
16
  "loanFirstPaymentDate401K": "2025-04-06",
17
  "loanIssueDate401K": "2025-04-06",
18
  "loanNumber": "string",
19
  "maximum": 0,
20
  "medicalSupport": true,
21
  "minimum": 0,
22
  "miscInfo": "string",
23
  "paidTowardsGoal": 0,
24
  "priority": 0,
25
  "rate": 0,

200Successfully Retrieved

500Internal Server Error