Retrieve PY Employee Deductions By Code
- 25 Sep 2024
- 1 Minute to read
- Print
- DarkLight
Retrieve PY Employee Deductions By Code
- Updated on 25 Sep 2024
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/hcm-rest-api/rest/1/pyempded
Query Standards
Finder
Following row finders are available for data filtering and optimizing request performance.
- Select By Code
- By UUID
Select By Code
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| PloCode | Plan Option Code | 401K 1% |
| DedCode | Deduction Type Code | 401K |
| PlanCode | Plan Code | 401K |
| EmpNo | Employee Number | 006 |
| EffStartDate | Effective Start Date | 2015-01-01 |
| EndDate | End Date | 2022-06-30 |
By UUID
This is an optional finder for querying a specific Employee Deduction by row ID.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | /hcm-rest-api/rest/1/pyempded/EFE1D405C9F306D2E05316821FAC680E |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleselectByCode; PloCode=401K 1%, DedCode=401K ,PlanCode=401K ,EmpNo=006, EffStartDate=2015-01-01, EndDate=2022-06-30
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleEmdVUuid
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
"items": [
{
"EmdCompCode": "001",
"EmdPrnCode": "WK",
"EmdEmpNo": "006",
"EmdDedCode": "401K",
"EmdDedName": "401K Deduction",
"EmdStartDate": "2015-01-01",
"EmdEffStartDate": "2015-01-01",
"EmdEndDate": null,
"EmdDedAmount": 1,
"EmdDedType": "L",
"EmdBaseCode": null,
"EmdContrAmt": null,
"EmdContrMaxAmt": null,
"EmdBaseAmt": null,
"EmdPlanCode": "401K",
"EmdPlanName": "401K",
"EmdPloCode": "401K 1%",
"EmdPloName": "401K 1%",
"EmdVendor": "0001-10-01T12:00:00Z",
"EmdVenName": "Sun Life Group",
"EmdOutOfAreaFlag": "N",
"EmdOthInsurFlag": "N",
"EmdOthInsurVendor": null,
"EmdOthPolicyNo": null,
"EmdOthPolicyName": null,
"EmdOthInsurEffDate": null,
"EmdComment": null,
"EmdDeductionSeq": 30950,
"EmdVendorAddCode": null,
"EmdDefaultAmount": 1,
"EmdMinMax": null,
"EmdMinMaxAmt": null,
"EmdTotalAmt": null,
"EmdEmplrContrEffectiveDate": null,
"EmdLtdTotalAmt": null,
"EmdUser": "ARCORO",
"EmdStartDateDisplay": "2015-01-01T12:00:00Z",
"EmdLastUpdDate": "2022-12-15T05:03:12Z",
"EmdVUuid": "EFE1D405C9F306D2E05316821FAC680E",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempded/EFE1D405C9F306D2E05316821FAC680E",
"name": "pyempded",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempded/EFE1D405C9F306D2E05316821FAC680E",
"name": "pyempded",
"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/pyempded",
"name": "pyempded",
"kind": "collection"
}
]
}object