Contents x
    Create new Deduction
    • 06 Jan 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Create new Deduction

    • Updated on 06 Jan 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /hcm-rest-api/rest/1/pydeduction

    Create Deductions

    UI Location: Human Capital Management - Human Resources - Benefit Administration - Deductions - Master

    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "DedCode": "LZT1", "DedDescription": "TEST DESCRIPTION", "DedShortDesc": "TEST SHORT", "DedType": "D", "DedBaseCode": "STAT", "DedCalcSeq": "91231", "DedForDepFlag": "N", "DedAllocationMethod": "DEF" }
    DedDescription
    string Required

    Describe the Deduction

    💻 UI Fieldname: *Description

    Max length30
    DedBaseCode
    string Required

    Identify the Base code on which the value is to be applied

    💻 UI Fieldname: Based On

    Max length4
    DedCode
    string Required

    Identify the Deduction

    💻 UI Fieldname: *Code

    Max length4
    DedType
    string Required

    Identify the Type as H/L/P

    💻 UI Fieldname: *Type

    Max length1
    DedForDepFlag
    string Required

    💻 UI Fieldname: Dependents Enrollment Allowed

    Max length1
    DedShortDesc
    string Required

    💻 UI Fieldname: *Short Description

    Max length16
    DedAllocationMethod
    string Required

    Job allocation method: DEF=default method, BASE=base wage, HRWK=hours worked, HRPD=hours paid. Currently only applicable for non-pw job allocation.

    💻 UI Fieldname: *Job Allocation Based On

    Max length4
    DedCalcSeq
    number Required

    💻 UI Fieldname: *Calculation Sequence

    DedVUuid
    string
    Max length64
    DedGrpName
    string
    Max length30
    DedPartialCfFlag
    string
    Max length1
    DedAmount
    number

    Value of the deduction in appropriation to its type

    💻 UI Fieldname: Amount

    Max length18
    DedLimitGrpName
    string
    Max length30
    DedBaseName
    string
    Max length30
    DedCreateApVoucher
    string

    💻 UI Fieldname: Create Voucher For Accts Payable

    Max length1
    DedProRatedFlag
    string

    Y: The Lump Sum deduction will be prorated

    Max length2
    DedLumpSum1planFlag
    string

    Applicable for EMPLOYEE LEVEL lump sum deduction. When Y only one plan/option will be deducted per pay period. This address for example health coverage whereby employee changes plan in the middle of a pay period.

    💻 UI Fieldname: *Employee Level Lump Sum Deduction. Deduct Only One Plan Per Pay Period

    Max length1
    DedPrintOrder
    number

    Identify Whether Benefit is because of Prevailing Wage restiricti

    💻 UI Fieldname: Print Order

    Max length4
    DedIuCreateDate
    string
    DedExcludeFlag
    string

    Flag to show ifthis deduction is to be calculated when no wages exist.

    💻 UI Fieldname: Exclude Without Wages

    Max length1
    DedInvoiceFlag
    string

    Include on Invoices

    💻 UI Fieldname: Include on Invoices

    Max length1
    DedIuUpdateUser
    string
    Max length30
    DedDeptAllocation
    string

    The Burden will be allocated to the Timesheet Department

    💻 UI Fieldname: Department Allocation

    Max length1
    DedIuCreateUser
    string
    Max length30
    DedJobAllocation
    string

    💻 UI Fieldname: Job Allocation

    Max length1
    DedUser
    string

    Name of the user who made last update

    Max length30
    DedInclPyFcBurdenCal
    string

    Y/N: Deduction Will Be Included Include In PY Forecast Burden Calculation, Available When PY FORECAST BURDEN CALCULATION Alternative Feature Is Installed

    Max length1
    DedIuUpdateDate
    string
    DedGrpCode
    string

    💻 UI Fieldname: Reporting Group

    Max length4
    DedWrlAllocation
    string

    💻 UI Fieldname: Work Location Allocation

    Max length1
    DedInclInRetropayCalcFlag
    string

    Yes to Include this Deductioni in Retropay Calculation

    💻 UI Fieldname: Include In Retropay Processing

    Max length1
    DedEmplrContr
    string

    Employer Contribution Multiplier

    💻 UI Fieldname: Employer Contribution

    Max length1
    DedLastUpdDate
    string

    Date and Time stamp of the last modification

    DedPriority
    number

    Numeric Values

    💻 UI Fieldname: Priority

    Max length4
    DedCfFlag
    string

    💻 UI Fieldname: Automatic Carry Forward

    Max length1
    DedLimitGrpCode
    string

    An optional code to group related deductions in order to apply a maximum limit on the sum.

    💻 UI Fieldname: Maximum Limit Group Code

    Max length4
    DedPkgFlag
    string

    "Y: The Lump Sum Deduction will be part of Package calculation for Salary employee

    Max length2
    DedBasecdAllocationFlag
    string

    Y/N: Whether to job allocate based on user-defined base code definition (only applicable under certain conditions, see deduction maint. and PY processing). [N] will use original standard allocation.

    💻 UI Fieldname: Job Allocate Using User-Defined Base Code

    Max length1
    DedMandatoryFlag
    string

    💻 UI Fieldname: Mandatory

    Max length1
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
  "DedCode": "LZT1",
  "DedDescription": "TEST DESCRIPTION",
  "DedShortDesc": "TEST SHORT",
  "DedGrpCode": null,
  "DedGrpName": null,
  "DedType": "D",
  "DedAmount": null,
  "DedBaseCode": "STAT",
  "DedBaseName": null,
  "DedEmplrContr": null,
  "DedJobAllocation": null,
  "DedPriority": null,
  "DedCfFlag": null,
  "DedPrintOrder": null,
  "DedCalcSeq": 91231,
  "DedPartialCfFlag": null,
  "DedMandatoryFlag": null,
  "DedForDepFlag": "N",
  "DedInvoiceFlag": null,
  "DedWrlAllocation": null,
  "DedCreateApVoucher": null,
  "DedExcludeFlag": null,
  "DedLimitGrpCode": null,
  "DedLimitGrpName": null,
  "DedDeptAllocation": null,
  "DedAllocationMethod": "DEF",
  "DedUser": null,
  "DedLastUpdDate": null,
  "DedBasecdAllocationFlag": null,
  "DedInclPyFcBurdenCal": null,
  "DedInclInRetropayCalcFlag": null,
  "DedLumpSum1planFlag": null,
  "DedIuCreateDate": null,
  "DedIuCreateUser": null,
  "DedIuUpdateDate": null,
  "DedIuUpdateUser": null,
  "DedProRatedFlag": null,
  "DedPkgFlag": null,
  "DedVUuid": "030B10A290630E79E06316821FAC49BA",
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/030B10A290630E79E06316821FAC49BA",
      "name": "pydeduction",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/030B10A290630E79E06316821FAC49BA",
      "name": "pydeduction",
      "kind": "item"
    }
  ]
}
    object
    What's Next
    Contact Us
    Copyright © 2024 CMiC All Rights Reserved