API Catalog

Create new Benefit Code

27 Feb 2025
2 Minutes to read

Print
Dark
Light

Create new Benefit Code

Updated on 27 Feb 2025
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/hcm-rest-api/rest/1/pycomben

Create Company Benefits

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

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

object

Example{ "CobCompCode": "001", "CobPygCode": "NONE", "CobPrnCode": "SM", "CobBenCode": "AUTO", "CobPlanCode": "SINGLE", "CobPloCode": "T-FREE", "CobStartDate": "2022-11-16", "CobBenType": "D", "CobDrAccCode": "87354", "CobCrAccCode": "87354", "CobFrqCode": 3.0, "CobBenAmount": 1.0, "CobRemittanceFrqCode": 3.0 }

CobPygCode

string Required

Identify the Pay Run Code

Max length4

CobCrAccCode

string Required

💻 UI Fieldname: *Credit Account Code

Max length16

CobFrqCode

number Required

Max length2

CobBenCode

string Required

Identify the Benefit

💻 UI Fieldname: *Benefit Code

Max length4

CobBenType

string Required

💻 UI Fieldname: *Benefit Type

Max length2

CobPlanCode

string Required

💻 UI Fieldname: *Plan Code

Max length10

CobStartDate

string Required

Effective Starting Date of the Benefit

💻 UI Fieldname: *Start Date

CobBenAmount

number Required

The respective value of the Benefit to be paid in appropriation t

Max length18

CobPrnCode

string Required

Identify the Pay Run Code

Max length4

CobPloCode

string Required

💻 UI Fieldname: *Plan Option

Max length10

CobDrAccCode

string Required

Respective Debit GL Account Code to the Benefit

💻 UI Fieldname: *Debit Account Code

Max length16

CobRemittanceFrqCode

number Required

Max length2

CobCompCode

string Required

Max length8

CobEmplrContrDeptName

string

Max length30

CobBenSecureFlag

string

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

Max length1

CobVendor

string

Max length8

CobEndDate

string

Effective Ending Date when to discontinue the Benefit

💻 UI Fieldname: End Date

CobCash

string

💻 UI Fieldname: Cash

Max length1

CobRemittanceTotAmt

number

Max length18

CobElegBaseCode

string

Base Code to be used to determine the Eligibility

Max length4

CobEmpleContrAccCode

string

Max length16

CobPrintBenFlag

string

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

Max length1

CobCalcAfterFirstChkFlag

string

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

Max length1

CobDrAccName

string

Max length4000

CobLastUpdDate

string

Date and Time stamp of the last modification

CobEmpleContrFactor

string

Max length1

CobBaseCode

string

Max length4

CobIuUpdateDate

string

CobBaseName

string

Max length30

CobDeptName

string

Max length30

CobContrMaxAmt

number

Max length18

CobIuCreateDate

string

CobElegFrqCode

number

Frequency for the Eligibility

Max length2

CobComment

string

Max length60

CobDeptCode

string

💻 UI Fieldname: Debit Dept. Code

Max length6

CobVenName

string

Max length50

CobContrAmt

number

Max length18

CobIuUpdateUser

string

Max length30

CobEmplrContrDeptCode

string

💻 UI Fieldname: Credit Dept. Code

Max length6

CobPlnName

string

Max length30

CobRemittanceAmtForAp

string

Max length1

CobIuCreateUser

string

Max length30

CobCrAccName

string

Max length4000

CobElegAmt

number

Value for the Eligibility

Max length18

CobUser

string

The name of the User who did last Update

Max length30

CobVUuid

string

Max length64

CobPloName

string

Max length30

CobBenName

string

Max length30

Responses

201

Created

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

{
  "CobEmpleContrAccCode": null,
  "CobVendor": null,
  "CobVenName": null,
  "CobCompCode": "001",
  "CobPrnCode": "SM",
  "CobPygCode": "NONE",
  "CobBenCode": "AUTO",
  "CobBenName": null,
  "CobStartDate": "2022-11-16",
  "CobEndDate": null,
  "CobFrqCode": 3,
  "CobBenAmount": 1,
  "CobDrAccCode": "87354",
  "CobDrAccName": null,
  "CobEmplrContrDeptCode": null,
  "CobEmplrContrDeptName": null,
  "CobPlanCode": "SINGLE",
  "CobPlnName": null,
  "CobPloCode": "T-FREE",
  "CobPloName": null,
  "CobBenType": "D",
  "CobEmpleContrFactor": null,
  "CobContrAmt": null,
  "CobContrMaxAmt": null,
  "CobCrAccCode": "87354",
  "CobCrAccName": null,
  "CobElegFrqCode": null,
  "CobElegAmt": null,
  "CobElegBaseCode": null,
  "CobBaseCode": null,
  "CobBaseName": null,
  "CobDeptCode": null,
  "CobDeptName": null,
  "CobPrintBenFlag": null,
  "CobCalcAfterFirstChkFlag": null,
  "CobComment": null,
  "CobRemittanceAmtForAp": null,
  "CobRemittanceFrqCode": 3,
  "CobRemittanceTotAmt": null,
  "CobBenSecureFlag": null,
  "CobUser": null,
  "CobCash": null,
  "CobLastUpdDate": null,
  "CobIuCreateDate": null,
  "CobIuCreateUser": null,
  "CobIuUpdateDate": null,
  "CobIuUpdateUser": null,
  "CobVUuid": "F296122AB85A72CCE05316821FAC52D0",
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomben/F296122AB85A72CCE05316821FAC52D0",
      "name": "pycomben",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomben/F296122AB85A72CCE05316821FAC52D0",
      "name": "pycomben",
      "kind": "item"
    }
  ]
}

object

What's Next

Retrieve Company Benefit Codes By Code

Create new Benefit Code

Create Company Benefits

What's Next

Contact Us