Contents x
      Create a PY Employee Deduction
      • 27 Feb 2025
      • 2 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Create a PY Employee Deduction

      • Updated on 27 Feb 2025
      • 2 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Post
      /hcm-rest-api/rest/1/pyempded

      Create Employee Deductions

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

      Security
      HTTP
      Type basic

      Basic authentication

      Header parameters
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceItem+json
      Body parameters
      object
      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-15T12:03:12-05:00", "EmdUser": "ARCORO", "EmdOutOfAreaFlag": "N", "EmdOthInsurFlag": "N", "EmdVUuid": "" }
      EmdPloName
      string Required

      Plan Optional Name

      Max length30
      EmdEffStartDate
      string Required

      💻 UI Fieldname: *Effective Date

      EmdStartDate
      string Required

      Effective Starting Date

      💻 UI Fieldname: Start Date

      EmdPlanName
      string Required

      Plan Name

      Max length30
      EmdOutOfAreaFlag
      string Required

      💻 UI Fieldname: *Out Of Area

      Max length1
      EmdDedCode
      string Required

      Identify the Deduction

      💻 UI Fieldname: Deduction Code

      Max length4
      EmdVUuid
      string Required

      Unique uuid of row. Leave Empty

      Max length64
      EmdPloCode
      string Required

      Plan Optional Code

      💻 UI Fieldname: Plan Option

      Max length10
      EmdLastUpdDate
      string Required

      Date and Time of the last update

      EmdCompCode
      string Required

      Company Code

      Max length8
      EmdPlanCode
      string Required

      Plan Code

      💻 UI Fieldname: Plan Code

      Max length10
      EmdDedType
      string Required

      Deduction Type

      💻 UI Fieldname: Deduction Type

      Max length2
      EmdPrnCode
      string Required

      Identify the Pay Run Code

      Max length4
      EmdUser
      string Required

      The name of the user who made the last update

      Max length30
      EmdEmpNo
      string Required

      The unique identifier of an employee

      Max length16
      EmdOthInsurFlag
      string Required
      Max length1
      EmdVendor
      string

      Vendor

      💻 UI Fieldname: Vendor

      Max length8
      EmdOthInsurVendor
      string
      Max length10
      EmdBaseCode
      string

      Base Code

      Max length4
      EmdVenName
      string

      Vendor Name

      Max length200
      EmdOthPolicyNo
      string
      Max length16
      EmdOthInsurEffDate
      string
      EmdMinMax
      string
      Max length1
      EmdDefaultAmount
      number
      EmdVendorAddCode
      string
      Max length5
      EmdContrAmt
      number

      Contract Amount

      💻 UI Fieldname: Employer Contribution

      Max length18
      EmdCompRefOraseq
      number
      Max length11
      EmdComment
      string

      Election or loan ID number

      💻 UI Fieldname: Comment

      Max length60
      EmdOthPolicyName
      string
      Max length30
      EmdEndDate
      string

      Effective Ending Date of the Deduction

      💻 UI Fieldname: End Date

      EmdStartDateDisplay
      string
      Max length10
      EmdLtdTotalAmt
      number

      Life-to-date total deduction amount allowed since the effective start date.

      💻 UI Fieldname: Life-To-Date Total Amount

      Max length18
      EmdBaseAmt
      number

      Base Amount

      💻 UI Fieldname: Base Amount

      Max length18
      EmdIuCreateUser
      string

      User who created record, Leave Blank

      Max length30
      EmdDeductionSeq
      number

      Identify the deduction record for the employee to thread user extensions through

      EmdTotalAmt
      number

      Total Amount

      💻 UI Fieldname: Yearly Total Amount

      Max length18
      EmdDedName
      string

      Deduction Name

      Max length30
      EmdMinMaxAmt
      number

      💻 UI Fieldname: Minimum Take Home

      Max length18
      EmdContrMaxAmt
      number

      Contract Maximum Amount

      💻 UI Fieldname: Maximum Contribution

      Max length18
      EmdEmplrContrEffectiveDate
      string

      💻 UI Fieldname: Employer Effective Date

      EmdDedAmount
      number

      The value of the deduction in line with its type

      💻 UI Fieldname: Deduction Amount

      Max length18
      Responses
      201

      Created

      Headers
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceitem+json
      {
  "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:12Z",
  "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"
    }
  ]
}
      object
      What's Next
      Contact Us
      Copyright © 2024 CMiC All Rights Reserved