Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Deduction

Get Deduction for Deduction Code

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

get/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}

Path parameters

companyIdstring required

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

employeeIdstring required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max

deductionCodestring required

Deduction Code

Headers

Authorizationstring required

Bearer + JWT

Response

Successfully Retrieved

agencystring

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

annualMaximumnumber

Year to Date dollar amount not to be exceeded for a deduction in the calendar year. <br />Decimal(12,2)

calcCodestring

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

caseNostring

Child Support Case Identifier number, case number or court order number.<br />Max length: 20

costCenter1string

Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10

costCenter2string

Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10

costCenter3string

Cost Center associated with deduction. Must match Company setup.<br /> Max length: 10

dcodestring

Deduction code. Must match Company setup. <br />Max length: 5

effectiveDatestring 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

endDatestring date

Stop date of a deduction or benefit. Common formats are MM-DD-CCYY, CCYY-MM-DD.

fipsCodestring

Child support Federal Information Process Standard (FIPS) code. <br />Max length: 7

frequencystring

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

goalnumber

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

isSelfInsuredPlanboolean

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

loanFirstPaymentDate401Kstring date

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

loanIssueDate401Kstring date

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

loanNumberstring

401K Loan number, required for 401K Loan deduction types. <br /> Max length: 50

maximumnumber

Maximum amount of the deduction on a single paycheck. <br /> Decimal(12,2)

medicalSupportboolean

Indicates if the employee qualifies for medical benefits that can be used to cover the child

minimumnumber

Minimum amount of the deduction on a single paycheck. <br /> Decimal(12,2)

miscInfostring

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

paidTowardsGoalnumber

Amount already paid toward goal.<br /> Decimal(12,2)

priorityinteger

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

ratenumber

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

reportTerminatedboolean

Indicates whether agency needs to be reported on terminated employee

startDatestring date

Start date of a deduction based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD

stateAbbrevstring

State for child support.<br /> Max length: 2