Get
/hcm-rest-api/rest/1/pyoverheadcoderates
Query Standards
Finder
Following row finder is available for data filtering and optimizing request performance.
- overheadFinder
overheadFinder
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| compCode | Company Code | GL |
| ovhCode | Overhead Code | JOB005 |
| ovhType | Overhead Type | J |
Security
HTTP
Type basic
Basic authentication
Query parameters
onlyData
boolean
Exampletrue
finder
string
ExampleoverheadFinder;compCode=GL,ovhCode=8810,ovhType=J
expand
string
ExamplePyOvHeadDetailViewObj
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
example-0
Retrieve PY Overhead Codes and Rates - Finder
{
"items": [
{
"OvhmActive": "N",
"OvhmCompCode": "GL",
"OvhmCode": "8810",
"OvhmDesc": "8810",
"OvhmRowid": "AAAr6tAAGAAB9ucAAC",
"OvhmType": "J",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E1260475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": [
{
"OvhdOhCatCode": "7000",
"OvhdAccCode": "1000",
"OvhdCatName": "All Categories",
"OvhdCompName": "CMiC-ZZ Test Company Incorp",
"OvhdDeptCode": "00",
"OvhdDeptSource": "S",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "M",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": "Others",
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": "00",
"OvhdOhPhsName": "Bidding",
"OvhdOraseq": 140,
"OvhdPctOrRate": 0.2,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uWAAK",
"OvhdTrdName": "All Trades",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "GL",
"OvhdOvhmCode": "8810",
"OvhdVUuid": "5B9FAE2E13DC475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "ALL",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ZZ",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2021-07-01T00:00:00-04:00",
"OvhdCatCode": "ALL"
},
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000.100",
"OvhdCatName": "All Categories",
"OvhdCompName": "All Companies",
"OvhdDeptCode": null,
"OvhdDeptSource": "J",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "M",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 136,
"OvhdPctOrRate": 11,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uVAAI",
"OvhdTrdName": "Mapping Tech",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "GL",
"OvhdOvhmCode": "8810",
"OvhdVUuid": "5B9FAE2E13CF475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "9373",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ALL",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2018-01-01T00:00:00-05:00",
"OvhdCatCode": "ALL"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pyoverheadcoderates",
"name": "pyoverheadcoderates",
"kind": "collection"
}
]
}example-1
Retrieve PY Overhead Codes and Rates - All
{
"items": [
{
"OvhmActive": "Y",
"OvhmCompCode": "CCC",
"OvhmCode": "D-AUTO",
"OvhmDesc": "auto dept",
"OvhmRowid": "AAAr6tAAGAAB9ufAAG",
"OvhmType": "D",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E128B475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": [
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000.100",
"OvhdCatName": "All Categories",
"OvhdCompName": "All Companies",
"OvhdDeptCode": "00",
"OvhdDeptSource": "S",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "R",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 163,
"OvhdPctOrRate": 500,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uXAAH",
"OvhdTrdName": "Electrical",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "CCC",
"OvhdOvhmCode": "D-AUTO",
"OvhdVUuid": "5B9FAE2E13EF475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "ELEC",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ALL",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2020-04-01T00:00:00-04:00",
"OvhdCatCode": "ALL"
},
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000.100",
"OvhdCatName": "All Categories",
"OvhdCompName": "All Companies",
"OvhdDeptCode": "00",
"OvhdDeptSource": "S",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "R",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 164,
"OvhdPctOrRate": 200,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uXAAI",
"OvhdTrdName": "Carpentor",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "CCC",
"OvhdOvhmCode": "D-AUTO",
"OvhdVUuid": "5B9FAE2E13F0475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "CARP",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ALL",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2020-04-01T00:00:00-04:00",
"OvhdCatCode": "ALL"
}
]
},
{
"OvhmActive": "Y",
"OvhmCompCode": "CCC",
"OvhmCode": "DFS",
"OvhmDesc": "sddsfsd",
"OvhmRowid": "AAAr6tAAGAAB9ufAAD",
"OvhmType": "J",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E1288475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": []
},
{
"OvhmActive": "Y",
"OvhmCompCode": "CCC",
"OvhmCode": "PYJOBOVHD1",
"OvhmDesc": "Payroll Job OverHead Markup",
"OvhmRowid": "AAAr6tAAGAAB9ubAAK",
"OvhmType": "J",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E1251475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": []
},
{
"OvhmActive": "Y",
"OvhmCompCode": "DSUS",
"OvhmCode": "OVHD",
"OvhmDesc": "OverHead",
"OvhmRowid": "AAAr6tAAGAAB9ueAAF",
"OvhmType": "J",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E127C475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": [
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000",
"OvhdCatName": "All Categories",
"OvhdCompName": "All Companies",
"OvhdDeptCode": "00",
"OvhdDeptSource": "S",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "R",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 2147483649,
"OvhdPctOrRate": 4,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uUAAK",
"OvhdTrdName": "All Trades",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "DSUS",
"OvhdOvhmCode": "OVHD",
"OvhdVUuid": "5B9FAE2E13C3475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "ALL",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ALL",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2019-03-13T00:00:00-04:00",
"OvhdCatCode": "ALL"
},
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000",
"OvhdCatName": "All Categories",
"OvhdCompName": "Diamond Services - US",
"OvhdDeptCode": null,
"OvhdDeptSource": "P",
"OvhdEmpName": "001 Hourly PYWK",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "M",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 2147483648,
"OvhdPctOrRate": 3,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uUAAI",
"OvhdTrdName": "Architect",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "DSUS",
"OvhdOvhmCode": "OVHD",
"OvhdVUuid": "5B9FAE2E13C1475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "1610",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "DSUS",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "PYMJ-WK-001",
"OvhdEffDate": "2013-01-01T00:00:00-05:00",
"OvhdCatCode": "ALL"
}
]
},
{
"OvhmActive": "N",
"OvhmCompCode": "GL",
"OvhmCode": "8810",
"OvhmDesc": "8810",
"OvhmRowid": "AAAr6tAAGAAB9ucAAC",
"OvhmType": "J",
"OvhmWDatatypeFlag": "N",
"OvhmVUuid": "5B9FAE2E1260475CE0630B811DAC84FB",
"PyOvHeadDetailViewObj": [
{
"OvhdOhCatCode": "7000",
"OvhdAccCode": "1000",
"OvhdCatName": "All Categories",
"OvhdCompName": "CMiC-ZZ Test Company Incorp",
"OvhdDeptCode": "00",
"OvhdDeptSource": "S",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "M",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": "Others",
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": "00",
"OvhdOhPhsName": "Bidding",
"OvhdOraseq": 140,
"OvhdPctOrRate": 0.2,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uWAAK",
"OvhdTrdName": "All Trades",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "GL",
"OvhdOvhmCode": "8810",
"OvhdVUuid": "5B9FAE2E13DC475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "ALL",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ZZ",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2021-07-01T00:00:00-04:00",
"OvhdCatCode": "ALL"
},
{
"OvhdOhCatCode": null,
"OvhdAccCode": "1000.100",
"OvhdCatName": "All Categories",
"OvhdCompName": "All Companies",
"OvhdDeptCode": null,
"OvhdDeptSource": "J",
"OvhdEmpName": "All Employees",
"OvhdHourName": "All Hour Types",
"OvhdMethod": "M",
"OvhdOhAccCode": null,
"OvhdOhAccName": null,
"OvhdOhCatName": null,
"OvhdOhDeptCode": null,
"OvhdOhDeptName": null,
"OvhdOhPhsCode": null,
"OvhdOhPhsName": null,
"OvhdOraseq": 136,
"OvhdPctOrRate": 11,
"OvhdPhsName": "All Phases",
"OvhdPrnName": "All Pay Runs",
"OvhdPygName": "All Groups",
"OvhdRowid": "AAAr6sAAGAAB9uVAAI",
"OvhdTrdName": "Mapping Tech",
"OvhdTshAccName": "All Accounts",
"OvhdTshDeptName": "All Departments",
"OvhdWorkCompCode": "GL",
"OvhdOvhmCode": "8810",
"OvhdVUuid": "5B9FAE2E13CF475CE0630B811DAC84FB",
"OvhdTshDeptCode": "ALL",
"OvhdTshAccCode": "ALL",
"OvhdTrdCode": "9373",
"OvhdPygCode": "ALL",
"OvhdPyCompCode": "ALL",
"OvhdPrnCode": "ALL",
"OvhdPhsCode": "ALL",
"OvhdHourType": "*",
"OvhdEmpNo": "ALL",
"OvhdEffDate": "2018-01-01T00:00:00-05:00",
"OvhdCatCode": "ALL"
}
]
}
],
"count": 5,
"hasMore": true,
"limit": 5,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pyoverheadcoderates",
"name": "pyoverheadcoderates",
"kind": "collection"
}
]
}object