Create new Company Deduction Code
    • 27 Feb 2025
    • 2 Minutes to read
    • Dark
      Light

    Create new Company Deduction Code

    • Dark
      Light

    Article summary

    Post
    /hcm-rest-api/rest/1/pycomded

    Create

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

    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "CodCompCode": "001", "CodPygCode": "NONE", "CodPrnCode": "SM", "CodDedCode": "401K", "CodPlanCode": "SINGLE", "CodPloCode": "T-FREE", "CodStartDate": "2022-11-16", "CodDedType": "D", "CodGlAccCode": "23510", "CodFrqCode": 3.0, "CodDedAmount": 1.0, "CodRemittanceFrqCode": 3.0 }
    CodPygCode
    string Required

    Identify the Pay Run Code

    Max length4
    CodPlanCode
    string Required

    💻 UI Fieldname: *Plan Code

    Max length10
    CodFrqCode
    number Required
    Max length2
    CodDedAmount
    number Required

    Deduction Amount

    Max length18
    CodGlAccCode
    string Required

    GL A/C Code for deduction

    💻 UI Fieldname: *Credit GL Account Code

    Max length16
    CodPrnCode
    string Required

    Identify the Pay Run Code

    Max length4
    CodPloCode
    string Required

    💻 UI Fieldname: *Plan Option

    Max length10
    CodStartDate
    string Required

    Effective Starting Date

    💻 UI Fieldname: *Start Date

    CodDedType
    string Required

    💻 UI Fieldname: *Deduction Type

    Max length2
    CodDedCode
    string Required

    Identify the Deduction

    💻 UI Fieldname: *Deduction Code

    Max length4
    CodCompCode
    string Required
    Max length8
    CodRemittanceFrqCode
    number Required
    Max length2
    CodEmplrContrAccName
    string
    Max length4000
    CodEndDate
    string

    Effective Ending Date

    💻 UI Fieldname: End Date

    CodRemittanceAmtForAp
    string
    Max length1
    CodVUuid
    string
    Max length64
    CodEmplrContrDeptCode
    string

    💻 UI Fieldname: Credit Dept. Code

    Max length6
    CodUser
    string

    The name of user who made the last update

    Max length30
    CodEmplrContrAccCode
    string
    Max length16
    CodElegBaseCode
    string

    Eligibility Base code

    Max length4
    CodContrMaxAmt
    number

    Deduction Amount

    Max length18
    CodDedName
    string
    Max length30
    CodVendor
    string
    Max length8
    CodElegFrqCode
    number

    Eligibility Frequency

    Max length2
    CodGlAccName
    string
    Max length4000
    CodIuUpdateDate
    string
    CodEmplrContrFactor
    string

    Employer Amount Factor: N/null=Flat Amount, Y=Multiplier Amount, H=Rate Per Normal Hours Worked

    Max length1
    CodIuCreateUser
    string
    Max length30
    CodPrintDedFlag
    string

    Flag represents either deductions have to be dispalyed on Check stub/Direct Deposit Pay stub or not.

    Max length1
    CodDeptName
    string
    Max length30
    DiscriminatorCode
    string
    CodIuCreateDate
    string
    CodIuUpdateUser
    string
    Max length30
    CodContrMaxType
    string
    Max length1
    CodBaseName
    string
    Max length30
    CodContrAmt
    number

    Deduction Amount

    Max length18
    CodComment
    string
    Max length60
    CodEmplrContrEffectiveDate
    string
    CodEmplrContrDeptName
    string
    Max length30
    CodPlanName
    string
    Max length30
    CodVenName
    string
    Max length50
    CodDedSecureFlag
    string

    print/display the Deduction in query screen only if checked to YES

    Max length1
    CodEmplrContr
    string

    💻 UI Fieldname: Employer Contribution In The Advanced Tab

    Max length1
    CodBaseCode
    string
    Max length4
    CodElegAmt
    number

    Value for the Eligibility

    Max length18
    CodLastUpdDate
    string

    Date and Time stamp of the last update made

    CodCalcAfterFirstChkFlag
    string

    Flag to indicate whether the deduction should be calculated only on first check ([Y]es or [N]o). Applicate only to hourly and percentage deductions

    Max length1
    CodRemittanceTotAmt
    number
    Max length18
    CodDeptCode
    string
    Max length6
    CodPloName
    string
    Max length30
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": null,
      "CodStartDate": "2022-11-16",
      "CodEndDate": null,
      "CodFrqCode": 3,
      "CodDedAmount": 1,
      "CodEmplrContrFactor": null,
      "CodContrAmt": null,
      "CodContrMaxAmt": null,
      "CodGlAccCode": "23510",
      "CodGlAccName": null,
      "CodEmplrContrAccCode": null,
      "CodEmplrContrAccName": null,
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": null,
      "CodEmplrContrDeptCode": null,
      "CodEmplrContrDeptName": null,
      "CodDedType": "D",
      "CodPlanCode": "SINGLE",
      "CodPlanName": null,
      "CodPloCode": "T-FREE",
      "CodPloName": null,
      "CodVendor": null,
      "CodVenName": null,
      "CodCompCode": "001",
      "CodPrnCode": "SM",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": null,
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": null,
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 3,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": null,
      "CodUser": null,
      "CodLastUpdDate": null,
      "CodIuCreateDate": null,
      "CodIuCreateUser": null,
      "CodIuUpdateDate": null,
      "CodIuUpdateUser": null,
      "CodEmplrContr": null,
      "CodVUuid": "F297003EE8C93CBFE05316821FAC07E5",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F297003EE8C93CBFE05316821FAC07E5",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F297003EE8C93CBFE05316821FAC07E5",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    }
    object