GET Recurring Deduction Detail

get https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}

Summary Description

This function will allow the API user to get the details for a specific deduction code on an employee record.

Response

Response body

array of objects

object

uuid

Resource ID of the record

employeeId

string | null

The Paylocity Employee ID. This is a unique value per Paylocity Company ID

companyId

string | null

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity

code

string | null

Deduction Code

type

string | null

Deduction Type

rate

double | null

Rate for the Deduction

arrear

double | null

Money that is owed

frequency

string | null

Frequency determines how often the deduction Rate is applied in payroll

calculationCode

string | null

Calculation Code that Applies to Deduction

agencyCode

string | null

Agency Code. These are custom per client

miscellaneousInfo

string | null

Miscellaneous Information

priority

int32 | null

Priority determines the order in which a deduction is subtracted from gross pay. Priorities 1-4 are reserved for Statutory deductions(necessary by law), while 5-7 are reserved for Voluntary deductions(employee-elected).

selfInsured

boolean | null

Self-Insured Plan Flag. This will generate Part III of the employee's 1095-C Form

recordType

string | null

The recordType field in our API plays a vital role in defining the current state of the record under consideration. This attribute can hold three different values, each describing a distinct temporal stage of the record.

Historical: If the recordType is set as 'Historical', it signifies that the record in question pertains to past data or events. This attribute is typically used for records that have been archived or are no longer active.
Current: A 'Current' recordType indicates that the record is active and relevant to the present time. These records are currently in use and contain up-to-date information.
Future dated: The 'Future dated' recordType is used for records that are scheduled for a future date. They represent planned or expected data or events.
By using the recordType field, users can accurately categorize their records based on their temporal status, making it easier to sort, manage, and analyze data effectively.

Current Future Historical Unknown

note

string | null

Deduction Notes

effectiveDate

date-time | null

Effective Date of the Deduction

beginCheckDate

date-time | null

Begin Check Date of the Deduction

endCheckDate

date-time | null

End Check Date of the Deduction

costCenters

array of objects | null

An array of objects representing the Cost Centers

costCenters

object

level

int32 | null

Cost center level (Levels are 1-3)

code

string | null

Cost Center Code associated with the Level. This must match a Paylocity Cost Center Code

limits

object

Limits are used to control the amount of an earning or deduction

loan401K

object

A 401K loan is a type of loan that allows you to borrow money against the balance of your 401K retirement plan, up to a certain limit. It's a way for individuals to access their retirement savings without incurring early withdrawal penalties or taxes. The borrower is expected to repay the loan, typically over five years, through payroll deductions. The values to insert a loan, like Loan Number, and First Payment Date are provided by the record keeper.

Language


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


xxxxxxxxxx
45
]
1
[
2
  {
3
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
    "employeeId": "string",
5
    "companyId": "string",
6
    "code": "string",
7
    "type": "string",
8
    "rate": 0,
9
    "arrear": 0,
10
    "frequency": "string",
11
    "calculationCode": "string",
12
    "agencyCode": "string",
13
    "miscellaneousInfo": "string",
14
    "priority": 0,
15
    "selfInsured": true,
16
    "recordType": "Current",
17
    "note": "string",
18
    "effectiveDate": "2025-04-07T20:33:50.123Z",
19
    "beginCheckDate": "2025-04-07T20:33:50.123Z",
20
    "endCheckDate": "2025-04-07T20:33:50.123Z",
21
    "costCenters": [
22
      {
23
        "level": 0,
24
        "code": "string",
25
        "additionalProp": {}

200Success