---
title: "Retrieve Pay Earnings By Code"
slug: "retrieve-pay-earnings-by-code"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/retrieve-pay-earnings-by-code"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Pay Earnings By Code

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 |

SecurityHTTPType basic

Basic authentication

Query parametersfinderstringExampleselectEarnings;companyCode=001, payRunCode=WK, employeeNum=007, payPeriod=1, payYear=2023
limitintegerExample500
offsetintegerExample0
totalResultsbooleanExampletrue
orderBystringExampleEmpernEarnCode:desc

Responses200

Successful response

<select class='api-response-data' aria-label='Media type'><option value='5e09e1cd-c8ec-4fe4-acdd-c327d1c0aa84'>application/json</option>
</select>