.png){kind=logo}
Retrieve Pay Earnings By Code
- 22 Oct 2025
- 1 Minute to read
- Print
- DarkLight
Retrieve Pay Earnings By Code
- Updated on 22 Oct 2025
- 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/ukgpayearnings
Query Standards
Finder
Following row finders are available for data filtering and optimizing request performance.
- Select Earnings
Select Earnings
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| companyCode | Company Code | 001 |
| payRunCode | Pay Run Code | WK |
| employeeNum | Employee Number | 007 |
| payPeriod | Pay Period | 1 |
| payYear | Pay Year | 2023 |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleselectEarnings;companyCode=001, payRunCode=WK, employeeNum=007, payPeriod=1, payYear=2023
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleEmpernEarnCode:desc
Responses
200
Successful response