API Catalog

Retrieve PY Pay Runs By Code

27 Feb 2025
2 Minutes to read

Print
Dark
Light

Retrieve PY Pay Runs By Code

Updated on 27 Feb 2025
2 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

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

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate;auditDate=2015-01-01

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExamplePrnCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - findByDate

{
  "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

{
  "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

What's Next

Retrieve PY Job Pay Groups By Code

Retrieve PY Pay Runs By Code

Query Standards

Finder

Find By Date

Primary Key

What's Next

Contact Us