--- updatedAt: 2026-02-10T18:50:36.000Z agentTools: siteIndex: https://developer.paylocity.com/llms.txt projectIndex: https://developer.paylocity.com/integrations/llms.txt --- # Get Deduction Codes **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. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Company Level Information", "version": "v1" }, "servers": [ { "url": "dc1demogwext.paylocity.com" } ], "paths": { "/apiHub/payroll/v1/companies/{companyId}/deductions": { "get": { "tags": [ "Payroll/HR" ], "summary": "Get Deduction Codes", "description": "**Summary Description**\n\nThe 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.\n\n**Use Cases**\n\n- Accounts Receivable: Deduction codes can be utilized to monitor discounts, allowances, or modifications applied to invoices or accounts payable.\n- 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.\n- Advantages: Deduction codes can be utilized to classify deductions associated with employee benefits like as health insurance, dental coverage, or retirement plans.\n- Loans and Debts: Lenders and financial organizations utilize deduction codes to precisely indicate the reason for deductions made for loan repayments, interest, or fees.\n- 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.\n", "x-explorer-enabled": false, "parameters": [ { "name": "companyId", "in": "path", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n **Allowable Values:**\r\n 9 char max", "required": true, "schema": { "type": "string" }, "example": "A12345" }, { "name": "Authorization", "in": "header", "description": "Authorization token. Ex. Bearer ...", "schema": { "type": "string" } }, { "name": "includeTotalCount", "in": "query", "description": "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.", "schema": { "type": "boolean", "default": true } }, { "name": "testMode", "in": "header", "description": "If true all responses are mocked and generated randomly.", "schema": { "type": "boolean", "default": false } }, { "name": "offset", "in": "query", "description": "Pagination offset.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Number of deduction codes per page.\r\n **Default Value:** 20\r\n **Maximum Value:** 100", "schema": { "type": "integer", "format": "int32", "default": 50 }, "example": 5 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeductionCodeDto" } } } } } } } } }, "components": { "schemas": { "CompanyDeductionTypeDto": { "type": "object", "properties": { "code": { "type": "string", "description": "A unique code representing a specific classification, allowing for efficient categorization and differentiation.", "nullable": true }, "category": { "type": "string", "description": "A descriptor indicating the category to which an entity or item belongs, enhancing its classification and understanding.", "nullable": true }, "calculationCode": { "type": "string", "description": "The code used for calculating the deduction type.", "nullable": true }, "overrideCalculationCode": { "type": "string", "description": "A code that overrides standard calculation rules or algorithms, enabling customized calculations for specific scenarios.", "nullable": true }, "w2Box": { "type": "string", "description": "A reference to a specific box on a W-2 tax form, aiding in the accurate reporting of various types of income and deductions.", "nullable": true }, "isGarnishmentDedType": { "type": "boolean", "description": "An indicator specifying whether an entity or item is categorized as a garnishment deduction type, aiding in payroll and deduction management.", "nullable": true } }, "additionalProperties": { "type": "object", "nullable": true } }, "DeductionCodeDto": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.", "nullable": true }, "code": { "type": "string", "description": "A distinct code representing a specific entity or item, serving as a concise reference for accurate identification and categorization.", "nullable": true }, "description": { "type": "string", "description": "A detailed textual explanation or label providing additional context and meaning to the associated code or entity.", "nullable": true }, "checkStubDescription": { "type": "string", "description": "A descriptive text that appears on an employee's check stub, offering transparency and clarity regarding payment details.", "nullable": true }, "priority": { "type": "integer", "description": "An indicator defining the priority or ranking of an item, allowing for prioritization and sorting within a specific context.", "format": "int32", "nullable": true }, "w2Box": { "type": "string", "description": "The W2 box code associated with the deduction.", "nullable": true }, "printOnCheckStub": { "type": "boolean", "description": "An indicator specifying whether the associated information or description should be printed on an employee's check stub.", "nullable": true }, "payPeriodMaximum": { "type": "number", "description": "The maximum amount deducted per pay period.", "format": "double", "nullable": true }, "payPeriodMinimum": { "type": "number", "description": "The minimum amount deducted per pay period.", "format": "double", "nullable": true }, "annualMaximum": { "type": "number", "description": "The maximum annual deduction amount.", "format": "double", "nullable": true }, "rate": { "type": "number", "description": "A numerical representation of a specific rate or value, often utilized in financial calculations and compensation structures.", "format": "double", "nullable": true }, "frequency": { "type": "string", "description": "The frequency of the deduction (e.g., monthly, weekly).", "nullable": true }, "calculationCode": { "type": "string", "description": "A code used in calculations to determine specific values or outcomes, aiding in complex computation scenarios.", "nullable": true }, "amount": { "type": "number", "description": "The fixed amount of the deduction.", "format": "double", "nullable": true }, "kCode": { "type": "string", "description": "A code or identifier, often unique to a particular context, facilitating specialized categorization or classification.", "nullable": true }, "agency": { "type": "string", "description": "The agency or entity responsible for the deduction.", "nullable": true }, "takePartial": { "type": "boolean", "description": "An indicator specifying whether partial deductions or actions should be taken, allowing for nuanced processing.", "nullable": true }, "autoMakeup": { "type": "boolean", "description": "An indicator defining whether automatic makeup or adjustments should be applied under specific conditions or criteria.", "nullable": true }, "isActive": { "type": "boolean", "description": "An indicator denoting the current status or active state of an entity or item, aiding in management and decision-making.", "nullable": true }, "includeOnYtdCompChart": { "type": "boolean", "description": "An indicator specifying whether the data should be included on a year-to-date compensation chart or report.", "nullable": true }, "source": { "type": "integer", "description": "The origin or source of data, indicating where the information was derived or obtained from within the system.", "format": "int32", "nullable": true }, "wasUsedInPayroll": { "type": "boolean", "description": "An indicator confirming whether the data was utilized in payroll processing, ensuring transparency in payroll calculations.", "nullable": true }, "benefitType": { "type": "string", "description": "The type or category of the deduction (e.g., health, retirement).", "nullable": true }, "selfInsured": { "type": "boolean", "description": "An indicator indicating whether an entity or item is self-insured, meaning it assumes responsibility for insurance coverage.", "nullable": true }, "isEmployerPaidMedicalLeave": { "type": "boolean", "description": "An indicator specifying whether an entity or item is related to employer-paid medical leave, offering clarity on benefit coverage.", "nullable": true }, "exemptTaxes": { "type": "array", "items": { "type": "string" }, "description": "A field indicating which taxes are exempted or excluded in specific scenarios, aiding in tax-related calculations and reporting.", "nullable": true }, "blockedTaxes": { "type": "array", "items": { "type": "string" }, "description": "A field specifying taxes that are blocked or restricted from certain calculations or processes, ensuring accurate taxation.", "nullable": true }, "type": { "$ref": "#/components/schemas/CompanyDeductionTypeDto" } }, "additionalProperties": { "type": "object", "nullable": true } } } } } ```