> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a PY Employee Deduction

> ## Create Employee Deductions

UI Location: Human Capital Management - US Payroll - Setup - Employees - Deductions

###

## OpenAPI

````json POST /hcm-rest-api/rest/1/pyempded
{
  "openapi": "3.0.0",
  "info": {
    "title": "API Catalog",
    "description": "",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://mobtest.cmiccloudr12.com/cmictestrti",
      "description": "CMIC API Server"
    }
  ],
  "security": [
    {
      "cmicBasicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Highlights"
    },
    {
      "name": "Asset Management | Equipment"
    },
    {
      "name": "Asset  Management | Fixed Assets"
    },
    {
      "name": "Asset Management | Purchase Order"
    },
    {
      "name": "Asset Management | Inventory"
    },
    {
      "name": "Asset Management | Requisition"
    },
    {
      "name": "Asset Management | Purchase Change Order"
    },
    {
      "name": "Bim Model"
    },
    {
      "name": "Bim Model Revision"
    },
    {
      "name": "Bim Tag Model"
    },
    {
      "name": "Bim Tags"
    },
    {
      "name": "Bim FileUpload Jersey"
    },
    {
      "name": "Core System | Business Partners"
    },
    {
      "name": "Core System | Business Partner Addresses"
    },
    {
      "name": "Core System | Bank"
    },
    {
      "name": "Core System | Currency"
    },
    {
      "name": "Core System | Exchange Rates"
    },
    {
      "name": "Core System | Global  Table Text Codes"
    },
    {
      "name": "Core System | Global Table  Regions"
    },
    {
      "name": "Core System | Terms"
    },
    {
      "name": "Core System | System Contact"
    },
    {
      "name": "Core System | Weight Measures"
    },
    {
      "name": "Core System | Field User Defined Classifiers"
    },
    {
      "name": "Core System | User Defined Classifiers by Object"
    },
    {
      "name": "Core System | User Extension Definitions by Object"
    },
    {
      "name": "Core System | User Extention Field Data Value"
    },
    {
      "name": "Core System | User Extension Values by Object"
    },
    {
      "name": "Core System | User System Role"
    },
    {
      "name": "Core System | User Project Role"
    },
    {
      "name": "Core System | Documents by Object"
    },
    {
      "name": "Core System | Audit Status Log by Object"
    },
    {
      "name": "Core System | Licensed Users"
    },
    {
      "name": "Core System | Company Access"
    },
    {
      "name": "Core System |  Copy User Settings"
    },
    {
      "name": "Core System | User Maintenance"
    },
    {
      "name": "Core System | User Roles"
    },
    {
      "name": "Core System | Security Groups"
    },
    {
      "name": "Core System | Job/Project Security"
    },
    {
      "name": "Core System | Weight Measure with Conversions Code"
    },
    {
      "name": "Core System | Weight Measure Conversions Code"
    },
    {
      "name": "Core System | User-defined-fields"
    },
    {
      "name": "Core System | User-extension"
    },
    {
      "name": "ECM and Workflow | Image Manager"
    },
    {
      "name": "Financials | General Ledger"
    },
    {
      "name": "Financials | Accounts Payable"
    },
    {
      "name": "Financials | Accounts Receivable"
    },
    {
      "name": "Preventative Maintenance | Issue Work Orders"
    },
    {
      "name": "Preventative Maintenance | Issue Work Items"
    },
    {
      "name": "Preventative Maintenance | Issue Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Issue Priorities"
    },
    {
      "name": "Preventative Maintenance | Issue Status"
    },
    {
      "name": "Preventative Maintenance | Issue Types"
    },
    {
      "name": "Preventative Maintenance | Accumulative Equipment"
    },
    {
      "name": "Preventative Maintenance | Work Orders"
    },
    {
      "name": "Preventative Maintenance | Work Items"
    },
    {
      "name": "Preventative Maintenance | Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Priorities"
    },
    {
      "name": "Preventative Maintenance | Tasks"
    },
    {
      "name": "HCM | UKG Pay Deductions"
    },
    {
      "name": "HCM | UKG Pay Earnings"
    },
    {
      "name": "HCM | UKG Pay Headers"
    },
    {
      "name": "HCM | UKG Pay Taxes"
    },
    {
      "name": "HCM | Payroll Geographical States"
    },
    {
      "name": "HCM | Payroll Trades"
    },
    {
      "name": "HCM | Payroll Union"
    },
    {
      "name": "HCM | Payroll Pay Runs"
    },
    {
      "name": "HCM | Payroll Pay Groups"
    },
    {
      "name": "HCM | Payroll Tax"
    },
    {
      "name": "HCM | Payroll Worker Compensation"
    },
    {
      "name": "HCM | Payroll Work Locations"
    },
    {
      "name": "HCM | Payroll Trade Pay Rates"
    },
    {
      "name": "HCM | Payroll Union Pay Rates"
    },
    {
      "name": "HCM | Payroll Job Pay Rates"
    },
    {
      "name": "HCM | Payroll Master Benefits"
    },
    {
      "name": "HCM | Payroll Master Deductions"
    },
    {
      "name": "HCM | Payroll Ben/Ded/Leave Base Codes"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plans"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plan Options"
    },
    {
      "name": "HCM | Payroll Company Benefits"
    },
    {
      "name": "HCM | Payroll Company Deductions"
    },
    {
      "name": "HCM | Payroll Vertex Geographic Locations"
    },
    {
      "name": "HCM | Payroll Checks"
    },
    {
      "name": "HCM | Payroll Timesheets"
    },
    {
      "name": "HCM | Employee"
    },
    {
      "name": "HCM | Employee (Minimum payload)"
    },
    {
      "name": "HCM | Employee History"
    },
    {
      "name": "HCM | Tax Exemptions"
    },
    {
      "name": "HCM | Employee Tax Overrides"
    },
    {
      "name": "HCM | Employee Pay Splits"
    },
    {
      "name": "HCM | Employee Benefits"
    },
    {
      "name": "HCM | Employee Clock In and Out"
    },
    {
      "name": "HCM | Employee Deductions"
    },
    {
      "name": "HCM | Employee Leaves"
    },
    {
      "name": "HCM | Employee Leave History"
    },
    {
      "name": "HCM | Employee Hour Types"
    },
    {
      "name": "HCM | Employee Pay History"
    },
    {
      "name": "HCM | Employee Work Statuses"
    },
    {
      "name": "HCM | Employee Security Group"
    },
    {
      "name": "HCM | Crewtime Crew"
    },
    {
      "name": "HCM | Crewtime Employee Timesheet"
    },
    {
      "name": "HCM | Crewtime Equipment Timesheet"
    },
    {
      "name": "HCM | Crew Maintenance Activity Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Trade and Union Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Detail Assignment"
    },
    {
      "name": "HCM | HR Requisitions"
    },
    {
      "name": "HCM | HR Relations"
    },
    {
      "name": "HCM | HR Employee Skills"
    },
    {
      "name": "HCM | HR Incident"
    },
    {
      "name": "HCM | HR Employee Relatives / Dependents"
    },
    {
      "name": "HCM | HR Employee Positions"
    },
    {
      "name": "HCM | HR Applicants"
    },
    {
      "name": "HCM | HR Applications"
    },
    {
      "name": "HCM | Vertex Location City"
    },
    {
      "name": "HCM | HR Application History"
    },
    {
      "name": "HCM | HR Dependent Benefits"
    },
    {
      "name": "HCM | HR Dependent Deductions"
    },
    {
      "name": "HCM | HR Employee Elected Plans"
    },
    {
      "name": "HCM | HR Employee Training Certifications"
    },
    {
      "name": "HCM | HR Trainings"
    },
    {
      "name": "HCM | E-Timesheets"
    },
    {
      "name": "HCM | System Contacts"
    },
    {
      "name": "HCM | System User Payroll Security Group"
    },
    {
      "name": "HCM | Payroll Timesheet Posting"
    },
    {
      "name": "HCM | CrewTimesheet Posting"
    },
    {
      "name": "HCM | HR Positions Master"
    },
    {
      "name": "HCM | Payroll Pay Periods"
    },
    {
      "name": "HCM | Payroll Rate Codes"
    },
    {
      "name": "HCM | Payroll Overhead Codes and Rates"
    },
    {
      "name": "HCM | Payroll Assigned Overhead to Jobs"
    },
    {
      "name": "Materials  Management | Material Sale Orders"
    },
    {
      "name": "Materials  Management | Material Sale Orders Details"
    },
    {
      "name": "Materials  Management | Truck Rate Detail"
    },
    {
      "name": "Opportunity Management | Competitors"
    },
    {
      "name": "Opportunity Management | Opportunities"
    },
    {
      "name": "Opportunity Management | Revenue Details"
    },
    {
      "name": "Opportunity Management | Opportunity History"
    },
    {
      "name": "Opportunity Management | Organization"
    },
    {
      "name": "Project Controls | Job Billing"
    },
    {
      "name": "Project Controls | Job Cost"
    },
    {
      "name": "Project Controls | PCI Details"
    },
    {
      "name": "Project Controls | Unposted PCI Details"
    },
    {
      "name": "Project Controls | PCI Headers"
    },
    {
      "name": "Project Controls | Owner Change Orders"
    },
    {
      "name": "Project Controls | CM Statuses"
    },
    {
      "name": "Project Controls | CM Types"
    },
    {
      "name": "Project Controls | CM Vendor Details"
    },
    {
      "name": "Project Controls | Post PCI"
    },
    {
      "name": "Project Management | Uploading Documents"
    },
    {
      "name": "Project Management | Downloading Documents"
    },
    {
      "name": "Project Management | Foreign Bid Item Imports"
    },
    {
      "name": "Project Management | Communications"
    },
    {
      "name": "Project Management | Daily Journals"
    },
    {
      "name": "Project Management | Communications Types"
    },
    {
      "name": "Project Management | Daily Journal Daily Work Plans"
    },
    {
      "name": "Project Management | Daily Journal Field Forces"
    },
    {
      "name": "Project Management | Daily Journal Labour"
    },
    {
      "name": "Project Management | Daily Journal Materials"
    },
    {
      "name": "Project Management | Daily Journal Owner Equipment"
    },
    {
      "name": "Project Management | Daily Journal Quality Control"
    },
    {
      "name": "Project Management | Daily Journal Tasks"
    },
    {
      "name": "Project Management | Daily Journal Trade Equipment"
    },
    {
      "name": "Project Management | Daily Journal Transactions"
    },
    {
      "name": "Project Management | Daily Journal User Defined Data"
    },
    {
      "name": "Project Management | Daily Journal Visitors"
    },
    {
      "name": "Project Management | Daily Journal Bill Details"
    },
    {
      "name": "Project Management | Field Work Directives"
    },
    {
      "name": "Project Management | Contract Types"
    },
    {
      "name": "Project Management | Company Contacts"
    },
    {
      "name": "Project Management | Distribution BCC"
    },
    {
      "name": "Project Management | Distribution CC"
    },
    {
      "name": "Project Management | Field Work Directive Statuses"
    },
    {
      "name": "Project Management | Issues"
    },
    {
      "name": "Project Management | Key Players"
    },
    {
      "name": "Project Management | Meetings"
    },
    {
      "name": "Project Management | Meeting Attendees"
    },
    {
      "name": "Project Management | Meeting Item Statuses"
    },
    {
      "name": "Project Management | Meeting Tracks"
    },
    {
      "name": "Project Management | Notes"
    },
    {
      "name": "Project Management | Projects"
    },
    {
      "name": "Project Management | Project Items"
    },
    {
      "name": "Project Management | Project Item Phase Segment Sums"
    },
    {
      "name": "Project Management | Project Partners"
    },
    {
      "name": "Project Management | Notices"
    },
    {
      "name": "Project Management | Notice Statuses"
    },
    {
      "name": "Project Management | Owner JS Query"
    },
    {
      "name": "Project Management | PCI Real Locations"
    },
    {
      "name": "Project Management | Project Contacts"
    },
    {
      "name": "Project Management | RFIs (Requests for Information)"
    },
    {
      "name": "Project Management | RFI Statuses"
    },
    {
      "name": "Project Management | Submittal Packages"
    },
    {
      "name": "Project Management | Submittal Package Details"
    },
    {
      "name": "Project Management | Submittal Package Status"
    },
    {
      "name": "Project Management | Submittals"
    },
    {
      "name": "Project Management | Submittal Status"
    },
    {
      "name": "Project Management | Transmittals"
    },
    {
      "name": "Project Management | Subcontract Headers"
    },
    {
      "name": "Project Management | Subcontract Schedules"
    },
    {
      "name": "Project Management | Subcontract Sechedule Phase Segment Sums"
    },
    {
      "name": "Project Management | User Roles"
    },
    {
      "name": "Project Management | Punchlists"
    },
    {
      "name": "Project Management | Punchlist Details"
    },
    {
      "name": "Project Management | Punchlist Statuses"
    },
    {
      "name": "Project Management | Meeting Items"
    },
    {
      "name": "Project Management | Self Perform Vendor"
    },
    {
      "name": "Project Management | Submittal Types"
    },
    {
      "name": "Project Management | Assign contact and partner to project"
    },
    {
      "name": "Project Management | Subcontract Prequal"
    },
    {
      "name": "Project Management | Bid Item Package"
    }
  ],
  "paths": {
    "/hcm-rest-api/rest/1/pyempded": {
      "post": {
        "tags": [
          "HCM | Employee Deductions"
        ],
        "summary": "Create a PY Employee Deduction",
        "description": "## Create Employee Deductions\n\nUI Location: Human Capital Management - US Payroll - Setup - Employees - Deductions\n\n###",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "EmdPloName": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "Plan Optional Name"
                  },
                  "EmdEffStartDate": {
                    "type": "string",
                    "description": "\n\n💻 UI Fieldname: \\*Effective Date"
                  },
                  "EmdStartDate": {
                    "type": "string",
                    "description": "Effective Starting Date\n\n💻 UI Fieldname: Start Date"
                  },
                  "EmdPlanName": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "Plan Name"
                  },
                  "EmdOutOfAreaFlag": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "\n\n💻 UI Fieldname: \\*Out Of Area"
                  },
                  "EmdDedCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "Identify the Deduction\n\n💻 UI Fieldname: Deduction Code"
                  },
                  "EmdVUuid": {
                    "type": "string",
                    "maxLength": 64,
                    "description": "Unique uuid of row. Leave Empty"
                  },
                  "EmdPloCode": {
                    "type": "string",
                    "maxLength": 10,
                    "description": "Plan Optional Code\n\n💻 UI Fieldname: Plan Option"
                  },
                  "EmdLastUpdDate": {
                    "type": "string",
                    "description": "Date and Time of the last update"
                  },
                  "EmdCompCode": {
                    "type": "string",
                    "maxLength": 8,
                    "description": "Company Code"
                  },
                  "EmdPlanCode": {
                    "type": "string",
                    "maxLength": 10,
                    "description": "Plan Code\n\n💻 UI Fieldname: Plan Code"
                  },
                  "EmdDedType": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "Deduction Type\n\n💻 UI Fieldname: Deduction Type"
                  },
                  "EmdPrnCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "Identify the Pay Run Code"
                  },
                  "EmdUser": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "The name of the user who made the last update"
                  },
                  "EmdEmpNo": {
                    "type": "string",
                    "maxLength": 16,
                    "description": "The unique identifier of an employee"
                  },
                  "EmdOthInsurFlag": {
                    "type": "string",
                    "maxLength": 1,
                    "description": ""
                  },
                  "EmdVendor": {
                    "type": "string",
                    "maxLength": 8,
                    "description": "Vendor\n\n💻 UI Fieldname: Vendor"
                  },
                  "EmdOthInsurVendor": {
                    "type": "string",
                    "maxLength": 10,
                    "description": ""
                  },
                  "EmdBaseCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "Base Code"
                  },
                  "EmdVenName": {
                    "type": "string",
                    "maxLength": 200,
                    "description": "Vendor Name"
                  },
                  "EmdOthPolicyNo": {
                    "type": "string",
                    "maxLength": 16,
                    "description": ""
                  },
                  "EmdOthInsurEffDate": {
                    "type": "string",
                    "description": ""
                  },
                  "EmdMinMax": {
                    "type": "string",
                    "maxLength": 1,
                    "description": ""
                  },
                  "EmdDefaultAmount": {
                    "type": "number",
                    "description": ""
                  },
                  "EmdVendorAddCode": {
                    "type": "string",
                    "maxLength": 5,
                    "description": ""
                  },
                  "EmdContrAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Contract Amount\n\n💻 UI Fieldname: Employer Contribution"
                  },
                  "EmdCompRefOraseq": {
                    "type": "number",
                    "maxLength": 11,
                    "description": ""
                  },
                  "EmdComment": {
                    "type": "string",
                    "maxLength": 60,
                    "description": "Election or loan ID number\n\n💻 UI Fieldname: Comment"
                  },
                  "EmdOthPolicyName": {
                    "type": "string",
                    "maxLength": 30,
                    "description": ""
                  },
                  "EmdEndDate": {
                    "type": "string",
                    "description": "Effective Ending Date of the Deduction\n\n💻 UI Fieldname: End Date"
                  },
                  "EmdStartDateDisplay": {
                    "type": "string",
                    "maxLength": 10,
                    "description": ""
                  },
                  "EmdLtdTotalAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Life-to-date total deduction amount allowed since the effective start date.\n\n💻 UI Fieldname: Life-To-Date Total Amount"
                  },
                  "EmdBaseAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Base Amount\n\n💻 UI Fieldname: Base Amount"
                  },
                  "EmdIuCreateUser": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "User who created record, Leave Blank"
                  },
                  "EmdDeductionSeq": {
                    "type": "number",
                    "description": "Identify the deduction record for the employee to thread user extensions through"
                  },
                  "EmdTotalAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Total Amount\n\n💻 UI Fieldname: Yearly Total Amount"
                  },
                  "EmdDedName": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "Deduction Name"
                  },
                  "EmdMinMaxAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "\n\n💻 UI Fieldname: Minimum Take Home"
                  },
                  "EmdContrMaxAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Contract Maximum Amount\n\n💻 UI Fieldname: Maximum Contribution"
                  },
                  "EmdEmplrContrEffectiveDate": {
                    "type": "string",
                    "description": "\n\n💻 UI Fieldname: Employer Effective Date"
                  },
                  "EmdDedAmount": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "The value of the deduction in line with its type\n\n💻 UI Fieldname: Deduction Amount"
                  }
                },
                "required": [
                  "EmdPloName",
                  "EmdEffStartDate",
                  "EmdStartDate",
                  "EmdPlanName",
                  "EmdOutOfAreaFlag",
                  "EmdDedCode",
                  "EmdVUuid",
                  "EmdPloCode",
                  "EmdLastUpdDate",
                  "EmdCompCode",
                  "EmdPlanCode",
                  "EmdDedType",
                  "EmdPrnCode",
                  "EmdUser",
                  "EmdEmpNo",
                  "EmdOthInsurFlag"
                ],
                "example": {
                  "EmdPloName": "401K 1%",
                  "EmdPloCode": "401K 1%",
                  "EmdStartDate": "2015-01-01",
                  "EmdCompCode": "001",
                  "EmdPrnCode": "WK",
                  "EmdDedCode": "401K",
                  "EmdDedType": "L",
                  "EmdPlanCode": "401K",
                  "EmdPlanName": "401K",
                  "EmdEmpNo": "006",
                  "EmdEffStartDate": "2022-01-01",
                  "EmdLastUpdDate": "2022-12-15T17:03:12+00:00",
                  "EmdUser": "ARCORO",
                  "EmdOutOfAreaFlag": "N",
                  "EmdOthInsurFlag": "N",
                  "EmdVUuid": ""
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "application/vnd.oracle.adf.resourceItem+json"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/vnd.oracle.adf.resourceitem+json"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "EmdCompCode": "001",
                  "EmdPrnCode": "WK",
                  "EmdEmpNo": "006",
                  "EmdDedCode": "401K",
                  "EmdDedName": null,
                  "EmdStartDate": "2015-01-01",
                  "EmdEffStartDate": "2022-01-01",
                  "EmdEndDate": null,
                  "EmdDedAmount": null,
                  "EmdDedType": "L",
                  "EmdBaseCode": null,
                  "EmdContrAmt": null,
                  "EmdContrMaxAmt": null,
                  "EmdBaseAmt": null,
                  "EmdPlanCode": "401K",
                  "EmdPlanName": "401K",
                  "EmdPloCode": "401K 1%",
                  "EmdPloName": "401K 1%",
                  "EmdVendor": null,
                  "EmdVenName": null,
                  "EmdOutOfAreaFlag": "N",
                  "EmdOthInsurFlag": "N",
                  "EmdOthInsurVendor": null,
                  "EmdOthPolicyNo": null,
                  "EmdOthPolicyName": null,
                  "EmdOthInsurEffDate": null,
                  "EmdComment": null,
                  "EmdDeductionSeq": null,
                  "EmdVendorAddCode": null,
                  "EmdDefaultAmount": null,
                  "EmdMinMax": null,
                  "EmdMinMaxAmt": null,
                  "EmdTotalAmt": null,
                  "EmdEmplrContrEffectiveDate": null,
                  "EmdLtdTotalAmt": null,
                  "EmdUser": "ARCORO",
                  "EmdStartDateDisplay": null,
                  "EmdLastUpdDate": "2022-12-15T17:03:12+00:00",
                  "EmdVUuid": "F29E92DB91174021E05316821FAC099D",
                  "links": [
                    {
                      "rel": "self",
                      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempded/F29E92DB91174021E05316821FAC099D",
                      "name": "pyempded",
                      "kind": "item"
                    },
                    {
                      "rel": "canonical",
                      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempded/F29E92DB91174021E05316821FAC099D",
                      "name": "pyempded",
                      "kind": "item"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cmicBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication"
      }
    }
  }
}
````