PApaylocity
Recurring Deductions

Get Employee Deductions [Batch]

Summary Description

This function will allow the API user to GET a list of all active deductions associated with the employee record.

get/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions
  • Auth
    none declared

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

A filter to use to limit results to a specific employee. Allowable Values: 255 char max

Query parameters

filterstring

The API Filter, by defining specific conditions, enables developers to fine-tune data from API calls for more precise results, enhancing application efficiency and user-friendliness. For more information review the Filtering page

limitinteger

Number of results per page. Default Value: 250 Maximum Value: 250

offsetinteger

Pagination offset

Headers

testModeboolean

If true all responses are mocked and generated randomly

Response

OK

idstring uuid

Resource ID of the record

employeeIdstring nullable

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

companyIdstring nullable

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

codestring nullable

Deduction Code

typestring nullable

Deduction Type

ratenumber double nullable

Rate for the Deduction

arrearnumber double nullable

Money that is owed

frequencystring nullable

Frequency determines how often the deduction Rate is applied in payroll

calculationCodestring nullable

Calculation Code that Applies to Deduction

agencyCodestring nullable

Agency Code. These are custom per client

miscellaneousInfostring nullable

Miscellaneous Information

priorityinteger nullable

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).

selfInsuredboolean nullable

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

recordType'Current' | 'Future' | 'Historical' | 'Unknown' nullable

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.

  1. 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.
  2. 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.
  3. 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.
notestring nullable

Deduction Notes

effectiveDatestring date-time nullable

Effective Date of the Deduction

beginCheckDatestring date-time nullable

Begin Check Date of the Deduction

endCheckDatestring date-time nullable

End Check Date of the Deduction

Changes

No recorded changes to this operation across all 1 revision of this API.