---
updatedAt: 2026-06-08T15:30:39.000Z
agentTools:
  siteIndex: https://developer.paylocity.com/llms.txt
  projectIndex: https://developer.paylocity.com/integrations/llms.txt
---

# Get Employee Deduction by resourceId

**Summary Description**

This function will allow the API user to get details for a particular deduction code that occurs in the past/present/future.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Pay Setup API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "dc1demogwext.paylocity.com"
    }
  ],
  "paths": {
    "/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{resourceId}": {
      "get": {
        "tags": [
          "Recurring Deductions"
        ],
        "summary": "Get Employee Deduction by resourceId",
        "description": "**Summary Description**\n\nThis function will allow the API user to get details for a particular deduction code that occurs in the past/present/future.",
        "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": "employeeId",
            "in": "path",
            "description": "A filter to use to limit results to a specific employee.\r\n                **Allowable Values:**\r\n                255 char max",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "deductionCode",
            "in": "path",
            "description": "Deduction Code",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "resourceId",
            "in": "path",
            "description": "Resource ID of the record",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "testMode",
            "in": "header",
            "description": "If true all responses are mocked and generated randomly",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetDeductionDto"
                },
                "examples": {
                  "Active Health Insurance Deduction": {
                    "value": {
                      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                      "employeeId": "EMP12345",
                      "companyId": "A12345",
                      "code": "HEALTH",
                      "type": "Voluntary",
                      "rate": 250,
                      "frequency": "PerPayPeriod",
                      "calculationCode": "FLAT",
                      "priority": 5,
                      "selfInsured": true,
                      "recordType": "Current",
                      "note": "Employee health insurance premium",
                      "effectiveDate": "2024-01-01T00:00:00",
                      "beginCheckDate": "2024-01-15T00:00:00",
                      "endCheckDate": "2024-12-31T00:00:00"
                    }
                  },
                  "Active 401k Deduction": {
                    "value": {
                      "id": "4fb85f64-5717-4562-b3fc-2c963f66afa7",
                      "employeeId": "EMP12345",
                      "companyId": "A12345",
                      "code": "401K",
                      "type": "Voluntary",
                      "rate": 500,
                      "frequency": "PerPayPeriod",
                      "calculationCode": "PERCENT",
                      "priority": 6,
                      "recordType": "Current",
                      "note": "401(k) retirement contribution",
                      "effectiveDate": "2024-01-01T00:00:00",
                      "beginCheckDate": "2024-01-15T00:00:00"
                    }
                  },
                  "Future Dated Deduction": {
                    "value": {
                      "id": "5fc85f64-5717-4562-b3fc-2c963f66afa8",
                      "employeeId": "EMP12345",
                      "companyId": "A12345",
                      "code": "DENTAL",
                      "type": "Voluntary",
                      "rate": 75,
                      "frequency": "PerPayPeriod",
                      "calculationCode": "FLAT",
                      "priority": 5,
                      "selfInsured": false,
                      "recordType": "Current",
                      "note": "Dental insurance starting next month",
                      "effectiveDate": "2024-07-01T00:00:00",
                      "beginCheckDate": "2024-07-15T00:00:00"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CostCenterDto": {
        "type": "object",
        "properties": {
          "level": {
            "type": "integer",
            "description": "Cost center level (Levels are 1-3)",
            "format": "int32",
            "nullable": true
          },
          "code": {
            "type": "string",
            "description": "Cost Center Code associated with the Level. This must match a Paylocity Cost Center Code",
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        },
        "description": "Cost Centers are organizational units within a company. Typically clients will break out their employees using cost centers like divisions, location and department."
      },
      "GetDeductionDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Resource ID of the record",
            "format": "uuid"
          },
          "employeeId": {
            "type": "string",
            "description": "The Paylocity Employee ID. This is a unique value per Paylocity Company ID",
            "nullable": true
          },
          "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": "Deduction Code",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "Deduction Type",
            "nullable": true
          },
          "rate": {
            "type": "number",
            "description": "Rate for the Deduction",
            "format": "double",
            "nullable": true
          },
          "arrear": {
            "type": "number",
            "description": "Money that is owed",
            "format": "double",
            "nullable": true
          },
          "frequency": {
            "type": "string",
            "description": "Frequency determines how often the deduction Rate is applied in payroll",
            "nullable": true
          },
          "calculationCode": {
            "type": "string",
            "description": "Calculation Code that Applies to Deduction",
            "nullable": true
          },
          "agencyCode": {
            "type": "string",
            "description": "Agency Code. These are custom per client",
            "nullable": true
          },
          "miscellaneousInfo": {
            "type": "string",
            "description": "Miscellaneous Information",
            "nullable": true
          },
          "priority": {
            "type": "integer",
            "description": "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).",
            "format": "int32",
            "nullable": true
          },
          "selfInsured": {
            "type": "boolean",
            "description": "Self-Insured Plan Flag. This will generate Part III of the employee's 1095-C Form",
            "nullable": true
          },
          "recordType": {
            "enum": [
              "Current",
              "Future",
              "Historical",
              "Unknown"
            ],
            "type": "string",
            "description": "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.\r\n1. **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.\r\n2. **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.\r\n3. **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.\r\nBy 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.",
            "nullable": true
          },
          "note": {
            "type": "string",
            "description": "Deduction Notes",
            "nullable": true
          },
          "effectiveDate": {
            "type": "string",
            "description": "Effective Date of the Deduction",
            "format": "date-time",
            "nullable": true
          },
          "beginCheckDate": {
            "type": "string",
            "description": "Begin Check Date of the Deduction",
            "format": "date-time",
            "nullable": true
          },
          "endCheckDate": {
            "type": "string",
            "description": "End Check Date of the Deduction",
            "format": "date-time",
            "nullable": true
          },
          "costCenters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CostCenterDto"
            },
            "description": "An array of objects representing the Cost Centers",
            "nullable": true
          },
          "limits": {
            "$ref": "#/components/schemas/GetLimitsDto"
          },
          "loan401K": {
            "$ref": "#/components/schemas/Loan401KDto"
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        },
        "description": "A Payroll Deduction code is a unique identifier used by payroll systems to categorize and track specific deductions from an employee's paycheck.\r\nThese deductions can include taxes, health insurance premiums, retirement contributions, loan repayments, and more.\r\nEach type of deduction has its own unique code that allows it to be easily identified and processed by the payroll system.\r\nThis not only ensures accurate calculations and disbursements, but also helps with record-keeping and reporting requirements."
      },
      "GetLimitsDto": {
        "type": "object",
        "properties": {
          "paidYearToDate": {
            "type": "number",
            "description": "Amount Paid Year to Date",
            "format": "double",
            "nullable": true
          },
          "goal": {
            "type": "number",
            "description": "The Goal is the deduction/earning limit. When deductions/earnings have met the limit, the employee pay deductions/earnings will stop.\r\nFor payroll, this amount is the lifetime deduction/earning limit.\r\nFor benefits, this limit amount could be annual.",
            "format": "double",
            "nullable": true
          },
          "paidToDate": {
            "type": "number",
            "description": "Paid to Date tracks the amount paid toward the Goal. The Paid to Date amount will never be more than the Goal amount",
            "format": "double",
            "nullable": true
          },
          "payPeriodMinimum": {
            "type": "number",
            "description": "Minimum for the pay period",
            "format": "double",
            "nullable": true
          },
          "payPeriodMaximum": {
            "type": "number",
            "description": "Maximum for the pay period",
            "format": "double",
            "nullable": true
          },
          "annualMaximum": {
            "type": "number",
            "description": "Entering an amount in the Annual Maximum field will override the system setting, and you'll need to manually manage the maximum each year.\r\nLeave this field blank to keep the system setting.",
            "format": "double",
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        },
        "description": "Limits are used to control the amount of an earning or deduction"
      },
      "Loan401KDto": {
        "type": "object",
        "properties": {
          "loanNumber": {
            "type": "string",
            "description": "401K Loan Number. Provided by Record Keeper",
            "nullable": true
          },
          "issueDate": {
            "type": "string",
            "description": "Date of 401K Loan Issued",
            "format": "date-time",
            "nullable": true
          },
          "firstPaymentDate": {
            "type": "string",
            "description": "First Payment Date of 401K Loan",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": {
          "type": "object",
          "nullable": true
        },
        "description": "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."
      }
    }
  }
}
```