API Catalog

Retrieve PY Employee Benefits By Code

25 Sep 2024
1 Minute to read

Print
Dark
Light

Retrieve PY Employee Benefits By Code

Updated on 25 Sep 2024
1 Minute to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/hcm-rest-api/rest/1/pyempben

Query Standards

Key	Recommended	Description
finder	Yes	Filters data based on attributes
limit	Yes	No. of items to return
offset	Yes	item index
totalResults	Yes	Returns total number of items
orderBy	Yes	Returns list of items order by given attribute

Finder

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

Select By Code
By UUID

Select By Code

This is the recommended finder for querying Employee Benefits by Plan Option Code, Benefit Type Code, Plan Code, Employee Number and Effective Start Date.

Parameter	Description	Sample
PloCode	Plan Option Code	CHILD
BenCode	Benefit Code	AD&D
PlanCode	Plan Code	DEFAULT
EmpNo	Employee Number	0116
EffStartDate	Effective Start Date	2016-01-01

By UUID

This is an optional finder for querying a specific Employee Benefit by row ID.

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

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectByCode; PloCode=CHILD, BenCode=AD%26D ,PlanCode=DEFAULT ,EmpNo=0116, EffStartDate=2016-01-01

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleEmbVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "EmbCompCode": "001",
      "EmbPrnCode": "SM",
      "EmbEmpNo": "0116",
      "EmbBenCode": "AD&D",
      "EmbBenName": "Accid Death & Dismemberment",
      "EmbStartDate": "2015-01-01",
      "EmbEffStartDate": "2016-01-01",
      "EmbEndDate": null,
      "EmbBenAmount": 15,
      "EmbUser": "FIELDPOINT",
      "EmbLastUpdDate": "2022-10-19T02:22:43Z",
      "EmbBenType": "L",
      "EmbBaseCode": null,
      "EmbContrAmt": null,
      "EmbContrMaxAmt": null,
      "EmbBaseAmt": null,
      "EmbPlanCode": "DEFAULT",
      "EmbPlanName": "DEFAULT PLAN",
      "EmbPloCode": "CHILD",
      "EmbPloName": "Child",
      "EmbVendor": "ZURICH",
      "EmbVenName": "Zurich Insurance Company",
      "EmbOutOfAreaFlag": "N",
      "EmbOthInsurFlag": "N",
      "EmbOthInsurVendor": null,
      "EmbOthPolicyNo": null,
      "EmbOthPolicyName": null,
      "EmbOthInsurEffDate": null,
      "EmbComment": null,
      "EmbBenefitSeq": 30937,
      "EmbVendorAddCode": null,
      "EmbDefaultAmount": 15,
      "EmbStartDateDisplay": "2015-01-01T12:00:00Z",
      "EmbVUuid": "EB5AE2343ABE4300E05316821FACCF90",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempben/EB5AE2343ABE4300E05316821FACCF90",
          "name": "pyempben",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempben/EB5AE2343ABE4300E05316821FACCF90",
          "name": "pyempben",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempben",
      "name": "pyempben",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific Employee Benefit By VUUID

Retrieve PY Employee Benefits By Code

Query Standards

Finder

Select By Code

By UUID

What's Next

Contact Us