Get Deduction Codes

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

Summary Description

The GET Deduction Codes by list by Company ID endpoint allows users to retrieve a comprehensive list of Deduction Codes details from a client's Paylocity instance. To use this endpoint, the Paylocity “deductions” parameter must be specified. Deduction Codes are alphanumeric or numeric identifiers used in financial and accounting systems to categorize and track various types of deductions. These deductions can include expenses, withholdings, reductions in pay, or other adjustments made to an individual's or organization's financial records. Pagination can be achieved by using the "deductions" parameter and specifying the values of "limit" and "offset" to decide the quantity of records to be retrieved. The utilization of the "limit" option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the "offset" option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned.

Use Cases

Accounts Receivable: Deduction codes can be utilized to monitor discounts, allowances, or modifications applied to invoices or accounts payable.
Taxes: Various tax jurisdictions employ deduction codes to describe the specific sort of tax being subtracted, such as federal income tax, state income tax, or local taxes.
Advantages: Deduction codes can be utilized to classify deductions associated with employee benefits like as health insurance, dental coverage, or retirement plans.
Loans and Debts: Lenders and financial organizations utilize deduction codes to precisely indicate the reason for deductions made for loan repayments, interest, or fees.
Expense Reporting: Deduction codes are utilized in company cost reporting to classify and monitor several types of spending, including travel, meals, entertainment, and office supplies.

Path Params

companyId

string

required

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

Query Params

includeTotalCount

boolean

Defaults to true

A boolean value representing whether the API should return the total number of resources available (even though only a subset may be returned). When includeTotalCount=true, then the X-Pcty-Total-Count response header should be added to the response and will specify the total number of records available. APIs that support X-Pcty-Total-Count should include this parameter in their specification.

offset

int32

Defaults to 0

Pagination offset.

limit

int32

Defaults to 50

Number of deduction codes per page.
Default Value: 20
Maximum Value: 100

Headers

Authorization

string

Authorization token. Ex. Bearer ...

testMode

boolean

Defaults to false

If true all responses are mocked and generated randomly.

Response

Response body

array of objects

object

companyId

string | null

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

code

string | null

A distinct code representing a specific entity or item, serving as a concise reference for accurate identification and categorization.

description

string | null

A detailed textual explanation or label providing additional context and meaning to the associated code or entity.

checkStubDescription

string | null

A descriptive text that appears on an employee's check stub, offering transparency and clarity regarding payment details.

priority

int32 | null

An indicator defining the priority or ranking of an item, allowing for prioritization and sorting within a specific context.

w2Box

string | null

The W2 box code associated with the deduction.

printOnCheckStub

boolean | null

An indicator specifying whether the associated information or description should be printed on an employee's check stub.

payPeriodMaximum

double | null

The maximum amount deducted per pay period.

payPeriodMinimum

double | null

The minimum amount deducted per pay period.

annualMaximum

double | null

The maximum annual deduction amount.

rate

double | null

A numerical representation of a specific rate or value, often utilized in financial calculations and compensation structures.

frequency

string | null

The frequency of the deduction (e.g., monthly, weekly).

calculationCode

string | null

A code used in calculations to determine specific values or outcomes, aiding in complex computation scenarios.

amount

double | null

The fixed amount of the deduction.

kCode

string | null

A code or identifier, often unique to a particular context, facilitating specialized categorization or classification.

agency

string | null

The agency or entity responsible for the deduction.

takePartial

boolean | null

An indicator specifying whether partial deductions or actions should be taken, allowing for nuanced processing.

autoMakeup

boolean | null

An indicator defining whether automatic makeup or adjustments should be applied under specific conditions or criteria.

isActive

boolean | null

An indicator denoting the current status or active state of an entity or item, aiding in management and decision-making.

includeOnYtdCompChart

boolean | null

An indicator specifying whether the data should be included on a year-to-date compensation chart or report.

source

int32 | null

The origin or source of data, indicating where the information was derived or obtained from within the system.

wasUsedInPayroll

boolean | null

An indicator confirming whether the data was utilized in payroll processing, ensuring transparency in payroll calculations.

benefitType

string | null

The type or category of the deduction (e.g., health, retirement).

selfInsured

boolean | null

An indicator indicating whether an entity or item is self-insured, meaning it assumes responsibility for insurance coverage.

isEmployerPaidMedicalLeave

boolean | null

An indicator specifying whether an entity or item is related to employer-paid medical leave, offering clarity on benefit coverage.

exemptTaxes

array of strings | null

A field indicating which taxes are exempted or excluded in specific scenarios, aiding in tax-related calculations and reporting.

exemptTaxes

blockedTaxes

array of strings | null

A field specifying taxes that are blocked or restricted from certain calculations or processes, ensuring accurate taxation.

blockedTaxes

type

object

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/deductions?includeTotalCount=true&offset=0&limit=50' \
3
     --header 'accept: application/json' \
4
     --header 'testMode: false'


xxxxxxxxxx
45
]
1
[
2
  {
3
    "companyId": "string",
4
    "code": "string",
5
    "description": "string",
6
    "checkStubDescription": "string",
7
    "priority": 0,
8
    "w2Box": "string",
9
    "printOnCheckStub": true,
10
    "payPeriodMaximum": 0,
11
    "payPeriodMinimum": 0,
12
    "annualMaximum": 0,
13
    "rate": 0,
14
    "frequency": "string",
15
    "calculationCode": "string",
16
    "amount": 0,
17
    "kCode": "string",
18
    "agency": "string",
19
    "takePartial": true,
20
    "autoMakeup": true,
21
    "isActive": true,
22
    "includeOnYtdCompChart": true,
23
    "source": 0,
24
    "wasUsedInPayroll": true,
25
    "benefitType": "string",

200OK