API Catalog

Retrieve Benefit Codes By Code

06 Jan 2025
3 Minutes to read

Print
Dark
Light

Retrieve Benefit Codes By Code

Updated on 06 Jan 2025
3 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/hcm-rest-api/rest/1/pybenefit

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Find By Date
By UUID

Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
AuditDate	Create or Update Date Time Filter	2022-12-20

By UUID

This is an optional finder for querying a specific Benefit Code by its Row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/hcm-rest-api/rest/1/pybenefit/EE17D067DE31139CE05316821FACD6EE

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate; auditDate=2014-12-20

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleBenCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "BenCode": "BLIF",
      "BenDescription": "Basic Life Insurance",
      "BenShortDesc": "Basic Life",
      "BenGrpCode": null,
      "BenGrpName": null,
      "BenPwFlag": "N",
      "BenType": "P",
      "BenAmount": null,
      "BenBaseCode": "BASE",
      "BenBaseName": "Base Wage",
      "BenCash": "N",
      "BenJobAllocation": "N",
      "BenPrintOrder": 1,
      "BenDedCode": null,
      "BenDedName": null,
      "BenCalcSeq": 2015,
      "BenEmpleContrFlag": null,
      "BenComment": null,
      "BenForDepFlag": "Y",
      "BenCalcFlag": "N",
      "BenWrlAllocation": "N",
      "BenJobAllocationAll": "N",
      "BenCreateApVoucher": "Y",
      "BenExcludeFlag": "N",
      "BenPrintCheckOnly": "N",
      "BenAssignedCheckNum": null,
      "BenCreateSeprateCheck": "N",
      "BenLimitGrpCode": null,
      "BenLimitGrpName": null,
      "BenInclInGcfStaffFlag": "N",
      "BenCalcPyOverheadFlag": "N",
      "BenDeptAllocation": "N",
      "BenAllocationMethod": "DEF",
      "BenUser": "ADWAIT",
      "BenLastUpdDate": "2015-05-01T20:08:33Z",
      "BenBasecdAllocationFlag": "N",
      "BenAccrualPaidoutFlag": "N",
      "BenInclPyFcBurdenCal": "N",
      "BenInclInRetropayCalcFlag": "N",
      "BenLumpSum1planFlag": "N",
      "BenIuCreateDate": "2015-05-01T20:08:33Z",
      "BenIuCreateUser": "ADWAIT",
      "BenIuUpdateDate": null,
      "BenIuUpdateUser": null,
      "BenProRatedFlag": null,
      "BenPkgFlag": null,
      "BenVUuid": "EE17D067DE55139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE55139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE55139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        }
      ]
    },
    {
      "BenCode": "GTL",
      "BenDescription": "Group Term Life",
      "BenShortDesc": "Group Term Life",
      "BenGrpCode": null,
      "BenGrpName": null,
      "BenPwFlag": "N",
      "BenType": "P",
      "BenAmount": null,
      "BenBaseCode": "BASE",
      "BenBaseName": "Base Wage",
      "BenCash": "N",
      "BenJobAllocation": "N",
      "BenPrintOrder": 1,
      "BenDedCode": null,
      "BenDedName": null,
      "BenCalcSeq": 4950,
      "BenEmpleContrFlag": null,
      "BenComment": null,
      "BenForDepFlag": "N",
      "BenCalcFlag": "N",
      "BenWrlAllocation": "N",
      "BenJobAllocationAll": "N",
      "BenCreateApVoucher": "Y",
      "BenExcludeFlag": "N",
      "BenPrintCheckOnly": "N",
      "BenAssignedCheckNum": null,
      "BenCreateSeprateCheck": "N",
      "BenLimitGrpCode": null,
      "BenLimitGrpName": null,
      "BenInclInGcfStaffFlag": "N",
      "BenCalcPyOverheadFlag": "N",
      "BenDeptAllocation": "N",
      "BenAllocationMethod": "DEF",
      "BenUser": "ADWAIT",
      "BenLastUpdDate": "2015-05-04T17:21:04Z",
      "BenBasecdAllocationFlag": "N",
      "BenAccrualPaidoutFlag": "N",
      "BenInclPyFcBurdenCal": "N",
      "BenInclInRetropayCalcFlag": "N",
      "BenLumpSum1planFlag": "N",
      "BenIuCreateDate": "2015-05-04T17:21:04Z",
      "BenIuCreateUser": "ADWAIT",
      "BenIuUpdateDate": null,
      "BenIuUpdateUser": null,
      "BenProRatedFlag": null,
      "BenPkgFlag": null,
      "BenVUuid": "EE17D067DE57139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE57139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE57139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        }
      ]
    },
    {
      "BenCode": "ESOP",
      "BenDescription": "Employee Stock Option Plan",
      "BenShortDesc": "ESOP",
      "BenGrpCode": null,
      "BenGrpName": null,
      "BenPwFlag": "N",
      "BenType": "P",
      "BenAmount": null,
      "BenBaseCode": "BASE",
      "BenBaseName": "Base Wage",
      "BenCash": "N",
      "BenJobAllocation": "N",
      "BenPrintOrder": 1,
      "BenDedCode": null,
      "BenDedName": null,
      "BenCalcSeq": 30500,
      "BenEmpleContrFlag": null,
      "BenComment": null,
      "BenForDepFlag": "N",
      "BenCalcFlag": "N",
      "BenWrlAllocation": "N",
      "BenJobAllocationAll": "N",
      "BenCreateApVoucher": "N",
      "BenExcludeFlag": "N",
      "BenPrintCheckOnly": "N",
      "BenAssignedCheckNum": null,
      "BenCreateSeprateCheck": "N",
      "BenLimitGrpCode": null,
      "BenLimitGrpName": null,
      "BenInclInGcfStaffFlag": "N",
      "BenCalcPyOverheadFlag": "N",
      "BenDeptAllocation": "N",
      "BenAllocationMethod": "DEF",
      "BenUser": "ADWAIT",
      "BenLastUpdDate": "2015-05-04T17:31:14Z",
      "BenBasecdAllocationFlag": "N",
      "BenAccrualPaidoutFlag": "N",
      "BenInclPyFcBurdenCal": "N",
      "BenInclInRetropayCalcFlag": "N",
      "BenLumpSum1planFlag": "N",
      "BenIuCreateDate": "2015-05-04T17:31:15Z",
      "BenIuCreateUser": "ADWAIT",
      "BenIuUpdateDate": null,
      "BenIuUpdateUser": null,
      "BenProRatedFlag": null,
      "BenPkgFlag": null,
      "BenVUuid": "EE17D067DE31139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE31139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DE31139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        }
      ]
    },
    {
      "BenCode": "GTLI",
      "BenDescription": "Group Term Life - Imputed",
      "BenShortDesc": "GTL Imputed",
      "BenGrpCode": null,
      "BenGrpName": null,
      "BenPwFlag": "N",
      "BenType": "P",
      "BenAmount": null,
      "BenBaseCode": "BASE",
      "BenBaseName": "Base Wage",
      "BenCash": "N",
      "BenJobAllocation": "N",
      "BenPrintOrder": 1,
      "BenDedCode": null,
      "BenDedName": null,
      "BenCalcSeq": 50000,
      "BenEmpleContrFlag": null,
      "BenComment": null,
      "BenForDepFlag": "N",
      "BenCalcFlag": "N",
      "BenWrlAllocation": "N",
      "BenJobAllocationAll": "N",
      "BenCreateApVoucher": "N",
      "BenExcludeFlag": "N",
      "BenPrintCheckOnly": "N",
      "BenAssignedCheckNum": null,
      "BenCreateSeprateCheck": "N",
      "BenLimitGrpCode": null,
      "BenLimitGrpName": null,
      "BenInclInGcfStaffFlag": "N",
      "BenCalcPyOverheadFlag": "N",
      "BenDeptAllocation": "N",
      "BenAllocationMethod": "DEF",
      "BenUser": "ADWAIT",
      "BenLastUpdDate": "2015-05-04T17:45:29Z",
      "BenBasecdAllocationFlag": "N",
      "BenAccrualPaidoutFlag": "N",
      "BenInclPyFcBurdenCal": "N",
      "BenInclInRetropayCalcFlag": "N",
      "BenLumpSum1planFlag": "N",
      "BenIuCreateDate": "2015-05-04T17:45:29Z",
      "BenIuCreateUser": "ADWAIT",
      "BenIuUpdateDate": null,
      "BenIuUpdateUser": null,
      "BenProRatedFlag": null,
      "BenPkgFlag": null,
      "BenVUuid": "EE17D067DEDC139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DEDC139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DEDC139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        }
      ]
    },
    {
      "BenCode": "HSAD",
      "BenDescription": "HSA Employee cont",
      "BenShortDesc": "HSAD",
      "BenGrpCode": null,
      "BenGrpName": null,
      "BenPwFlag": "N",
      "BenType": "P",
      "BenAmount": null,
      "BenBaseCode": "BASE",
      "BenBaseName": "Base Wage",
      "BenCash": "Y",
      "BenJobAllocation": "N",
      "BenPrintOrder": 1,
      "BenDedCode": null,
      "BenDedName": null,
      "BenCalcSeq": 271,
      "BenEmpleContrFlag": null,
      "BenComment": null,
      "BenForDepFlag": "N",
      "BenCalcFlag": "N",
      "BenWrlAllocation": "N",
      "BenJobAllocationAll": "N",
      "BenCreateApVoucher": "N",
      "BenExcludeFlag": "N",
      "BenPrintCheckOnly": "N",
      "BenAssignedCheckNum": null,
      "BenCreateSeprateCheck": "N",
      "BenLimitGrpCode": null,
      "BenLimitGrpName": null,
      "BenInclInGcfStaffFlag": "N",
      "BenCalcPyOverheadFlag": "N",
      "BenDeptAllocation": "N",
      "BenAllocationMethod": "DEF",
      "BenUser": "ADWAIT",
      "BenLastUpdDate": "2015-05-04T17:49:33Z",
      "BenBasecdAllocationFlag": "N",
      "BenAccrualPaidoutFlag": "N",
      "BenInclPyFcBurdenCal": "N",
      "BenInclInRetropayCalcFlag": "N",
      "BenLumpSum1planFlag": "N",
      "BenIuCreateDate": "2015-05-04T17:49:33Z",
      "BenIuCreateUser": "ADWAIT",
      "BenIuUpdateDate": null,
      "BenIuUpdateUser": null,
      "BenProRatedFlag": null,
      "BenPkgFlag": null,
      "BenVUuid": "EE17D067DF48139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DF48139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/EE17D067DF48139CE05316821FACD6EE",
          "name": "pybenefit",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit",
      "name": "pybenefit",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific PY Benefit

Retrieve Benefit Codes By Code

Query Standards

Finder

Find By Date

By UUID

What's Next

Contact Us