---
title: "Retrieve PY Pay Runs By Code"
slug: "retrieve-py-pay-runs-by-code"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/retrieve-py-pay-runs-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 PY Pay Runs By Code

Get/hcm-rest-api/rest/1/pypayrun

## Query Standards

### Finder

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

- Find By Date
- Primary Key

#### Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

| Parameter | Description | Sample |
| --- | --- | --- |
| auditDate | Create or Update Date Time Filter | 2022-12-20 |

#### Primary Key

This is an optional finder for querying a specific Pay Run by Primary Key (Payrun code)

| Parameter | Description | Sample |
| --- | --- | --- |
| PrnCode | PayRun Code | 1 |

SecurityHTTPType basic

Basic authentication

Query parametersfinderstringExamplefindByDate;auditDate=2015-01-01
limitintegerExample500
offsetintegerExample0
totalResultsbooleanExampletrue
orderBystringExamplePrnCode:desc

Responses200

OK

HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourcecollection+json
<select class='api-response-data' aria-label='Media type'><option value='4f85d35f-6559-410c-8e9e-4b8cd35da710'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='38dc53d9-2be8-4c07-94b8-2caa57d4cd49'>example-0</option>
<option value='19637757-3e09-4f90-8d58-51ceb5453c5d'>example-1</option>
</select>example-0

Successful Response - Finder - findByDate

```json
{
  "items": [
    {
      "PrnCode": "1",
      "PrnDescription": "Annual",
      "PrnShortDesc": "Annual",
      "PrnType": "Y",
      "PrnFrqCode": 7,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-01-17T21:12:07Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-01-17T21:12:07Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": "2023-02-01T17:14:05Z",
      "PrnIuUpdateUser": "ARCORO",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/1",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/1",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    },
    {
      "PrnCode": "BI",
      "PrnDescription": "BiWeekly",
      "PrnShortDesc": "BiWeekly",
      "PrnType": "Y",
      "PrnFrqCode": 2,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-01-17T21:12:32Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-01-17T21:12:32Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": null,
      "PrnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/BI",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/BI",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    },
    {
      "PrnCode": "BONU",
      "PrnDescription": "Qtrly Bonus",
      "PrnShortDesc": "Qrtly Bonus",
      "PrnType": "Y",
      "PrnFrqCode": 5,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-05-03T18:49:07Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-05-03T18:49:07Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": null,
      "PrnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/BONU",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/BONU",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    },
    {
      "PrnCode": "M",
      "PrnDescription": "Monthly",
      "PrnShortDesc": "Monthly",
      "PrnType": "Y",
      "PrnFrqCode": 4,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-02-01T17:14:04Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-02-01T17:14:04Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": null,
      "PrnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/M",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/M",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    },
    {
      "PrnCode": "Q",
      "PrnDescription": "Quarterly",
      "PrnShortDesc": "Quarterly",
      "PrnType": "Y",
      "PrnFrqCode": 5,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-02-01T17:14:04Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-02-01T17:14:04Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": null,
      "PrnIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/Q",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/Q",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun",
      "name": "pypayrun",
      "kind": "collection"
    }
  ]
}
```

example-1

Successful Response - Finder - PrimaryKey

```json
{
  "items": [
    {
      "PrnCode": "1",
      "PrnDescription": "Annual",
      "PrnShortDesc": "Annual",
      "PrnType": "Y",
      "PrnFrqCode": 7,
      "PrnUser": "ARCORO",
      "PrnLastUpdDate": "2023-01-17T21:12:07Z",
      "PrnAutoTimshtFlag": "Y",
      "Prn401kDedFlag": null,
      "PrnIuCreateDate": "2023-01-17T21:12:07Z",
      "PrnIuCreateUser": "ARCORO",
      "PrnIuUpdateDate": "2023-02-01T17:14:05Z",
      "PrnIuUpdateUser": "ARCORO",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/1",
          "name": "pypayrun",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun/1",
          "name": "pypayrun",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypayrun",
      "name": "pypayrun",
      "kind": "collection"
    }
  ]
}
```

object