Employee Benefits & Deductions

Capturing benefit change records between HR and Insurance Provider

Capturing change records for Benefit Open Enrollment and Qualifying events between HR and Insurance Provider.

Step 1: Retrieve Employee

Find employee using a finder e.g.

finder=PyEmployeeFinder;EmpNoVar=02085

Request

curl --location --request GET 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyemployee?finder=PyEmployeeFinder;EmpNoVar=02085&onlyData=true' \
--header 'Authorization: Basic Your-User:Pass'

Step 2: Retrieve Employee benefits

Retrieve benefits for employee using the finder e.g.

selectByCode;EmpNo=02085

Request

curl --location --request GET 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempben?finder=selectByCode;EmpNo=02085&onlyData=true' \
--header 'Authorization: Basic Your-User:Pass'

Step 3: Retrieve Employee deductions

Find employee deduction using finder parameters e.g.

finder=selectByCode;EmpNo=02085

Request

curl --location --request GET 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempded?finder=selectByCode;EmpNo=02085' \
--header 'Authorization: Basic Your-User:Pass'

Step 4: Update Employee

Request

curl --location --request POST 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyemployee?finder=PyEmployeeFinder;EmpNoVar=02085&onlyData=true' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic Your-User:Pass' \
--data-raw '{
  "EmpUser": "CMICUSER",
  "EmpNo": "02085",
  "EmpCompCode": "001",
  "EmhActionCode": "CH",
  "EmhEffectiveDate": "2022-06-01",
  "EmpVUuid": ""
}'

Step 5: Create Employee Benefit

Request

curl --location --request POST 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempben' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic Basic Your-User:Pass' \
--data-raw '{
    "EmbBenAmount": 150.00,
    "EmbBenCode": "DENT",
    "EmbBenName": "Dental",
    "EmbBenType": "L",
    "EmbCompCode": "10",
    "EmbEffStartDate": "2012-07-12T00:00:00-05:00",
    "EmbEmpNo": "02085",
    "EmbLastUpdDate": "2015-12-12T16:00:25-05:00",
    "EmbOthInsurFlag": "N",
    "EmbOutOfAreaFlag": "N",
    "EmbPlanCode": "DEFAULT",
    "EmbPlanName": "default",
    "EmbPloCode": "DEFAULT",
    "EmbPloName": "Default",
    "EmbPrnCode": "WK",
    "EmbStartDate": "2012-07-12T00:00:00-05:00",
    "EmbStartDateDisplay": "10-01-01",
    "EmbUser": "da",
    "EmbVUuid": ""
}'

Step 6: Create Employee Deduction

Request

curl --location --request POST 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempded' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic U09MVVRJT05TfHxDTUlDVVNFUjphMyNDIy04NkFDYi1iQ0QjMS0jQUY4OS1GI0NERi0jMzgyYi1lI0Y=' \
--data-raw '{
    "EmdCompCode": "10",
    "EmdPrnCode": "WK",
    "EmdEmpNo": "02085",
    "EmdDedCode": "401K",
    "EmdDedName": "401K Deduction",
    "EmdStartDate": "2010-01-01T00:00:00-05:00",
    "EmdEffStartDate": "2012-01-03T00:00:00-05:00",
    "EmdDedAmount": 1,
    "EmdDedType": "P",
    "EmdPlanCode": "401K",
    "EmdPlanName": "401K 1%",
    "EmdPloCode": "401K 1%",
    "EmdPloName": "401K 1%",
    "EmdVendor": "10-001",
    "EmdVenName": "Sun Life Group",
    "EmdOutOfAreaFlag": "N",
    "EmdOthInsurFlag": "N",
    "EmdDeductionSeq": 30028154,
    "EmdDefaultAmount": 0,
    "EmdMinMax": "N",
    "EmdUser": "da",
    "EmdStartDateDisplay": "10-01-01",
    "EmdLastUpdDate": "2011-05-31T11:24:50-04:00",
    "EmdVUuid": ""
}'

Step 7: Update Employee Benefits

Update benefit amount for a specific employee benefit using the UUID.

EmbBenAmount : 10

Request

curl --location --request POST 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempben/A9E3CEEE6E4F015EE05313061FAC4A1B' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic Basic Your-User:Pass' \
--data-raw '{
    "EmbBenAmount": 10
}'

Step 8 : Update Employee Deductions

Update deduction amount for a specific employee deduction using the UUID.

EmdDedAmount: 10

Request

curl --location --request PATCH 'https://mobtest.cmiccloudr12.com/cmictestrti/hcm-rest-api/rest/1/pyempded/E82FD93049C47825E05313061FACF834' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic Basic Your-User:Pass' \
--data-raw '{
	"EmdDedAmount": 10
}'