Create a PY Employee Benefit
- 06 Jan 2025
- 1 Minute to read
- Print
- DarkLight
Create a PY Employee Benefit
- Updated on 06 Jan 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/hcm-rest-api/rest/1/pyempben
Create Employee Benefits
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
Example{ "EmbPloName": "Child", "EmbPloCode": "CHILD", "EmbStartDate": "2022-10-01", "EmbCompCode": "001", "EmbPrnCode": "SM", "EmbBenCode": "AD&D", "EmbPlanCode": "DEFAULT", "EmbPlanName": "DEFAULT PLAN", "EmbEmpNo": "0116", "EmbEffStartDate": "2023-01-01", "EmbLastUpdDate": "2022-10-18T22:22:43-04:00", "EmbUser": "FIELDPOINT", "EmbOutOfAreaFlag": "N", "EmbOthInsurFlag": "N", "EmbVUuid": "" }
EmbVUuid
string
Unique id of Row, leave blank
💻 UI Fieldname: EmbVUuid
Max length64
EmbPloName
string
Plan Option Name
💻 UI Fieldname: EmbPloName
Max length30
EmbLastUpdDate
string
Date and Time stamp of the last update
💻 UI Fieldname: EmbLastUpdDate
EmbStartDate
string
Effective Starting Date of the Benefit
💻 UI Fieldname: EmbStartDate
EmbOthInsurFlag
string
💻 UI Fieldname: EmbOthInsurFlag
Max length1
EmbOutOfAreaFlag
string
Out of Area Flag
💻 UI Fieldname: EmbOutOfAreaFlag
Max length1
EmbPrnCode
string
Pay Run Code
💻 UI Fieldname: EmbPrnCode
Max length4
EmbPloCode
string
Plan Option Code
💻 UI Fieldname: EmbPloCode
Max length10
EmbBenCode
string
Benefit Code
💻 UI Fieldname: EmbBenCode
Max length4
EmbEffStartDate
string
Effective Date
💻 UI Fieldname: EmbEffStartDate
EmbPlanName
string
Plan Name
💻 UI Fieldname: EmbPlanName
Max length30
EmbEmpNo
string
The unique identifier of an employee
💻 UI Fieldname: EmbEmpNo
Max length16
EmbCompCode
string
Company Code
💻 UI Fieldname: EmbCompCode
Max length8
EmbUser
string
The name of the user who made the last update
💻 UI Fieldname: EmbUser
Max length30
EmbPlanCode
string
Plan Code
💻 UI Fieldname: EmbPlanCode
Max length10
Responses
201
Created
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
{
"EmbCompCode": "001",
"EmbPrnCode": "SM",
"EmbEmpNo": "0116",
"EmbBenCode": "AD&D",
"EmbBenName": null,
"EmbStartDate": "2022-10-01",
"EmbEffStartDate": "2023-01-01",
"EmbEndDate": null,
"EmbBenAmount": null,
"EmbUser": "FIELDPOINT",
"EmbLastUpdDate": "2022-10-19T02:22:43Z",
"EmbBenType": null,
"EmbBaseCode": null,
"EmbContrAmt": null,
"EmbContrMaxAmt": null,
"EmbBaseAmt": null,
"EmbPlanCode": "DEFAULT",
"EmbPlanName": "DEFAULT PLAN",
"EmbPloCode": "CHILD",
"EmbPloName": "Child",
"EmbVendor": null,
"EmbVenName": null,
"EmbOutOfAreaFlag": "N",
"EmbOthInsurFlag": "N",
"EmbOthInsurVendor": null,
"EmbOthPolicyNo": null,
"EmbOthPolicyName": null,
"EmbOthInsurEffDate": null,
"EmbComment": null,
"EmbBenefitSeq": null,
"EmbVendorAddCode": null,
"EmbDefaultAmount": null,
"EmbStartDateDisplay": null,
"EmbVUuid": "F31A71AB5179409BE05316821FAC5E4B",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempben/F31A71AB5179409BE05316821FAC5E4B",
"name": "pyempben",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempben/F31A71AB5179409BE05316821FAC5E4B",
"name": "pyempben",
"kind": "item"
}
]
}object