Retrieve PY Rate codes

Prev Next
Get
/hcm-rest-api/rest/1/pypayratecode

Query Standards

Finder

Following row finder is available for data filtering and optimizing request performance.

  • RateCodeBySearch

RateCodeBySearch

Recommended finder parameters. Refer to Query Parameters for example.

Parameter Description Sample
rateCode Rate Code Filter OT
rateDesc Rate Description Filter Overtime
rateMultiplier Rate Multiplier Filter 2.5
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExampleRateCodeBySearch;rateDesc=Night Shift Prem
onlyData
boolean
Exampletrue
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
example-0

Successful Response - Finder - RateCodeBySearch

{
  "items": [
    {
      "RcdCode": "NIGH",
      "RcdDescription": "Night Shift Prem",
      "RcdIuCreateDate": "2021-04-28T14:37:50-04:00",
      "RcdIuCreateUser": "IMRAN",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1.25,
      "RcdPremPerHourAmt": 1.5,
      "RcdShortDesc": "NS Premium",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78325E4E0630B811DAC6F72"
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pypayratecode",
      "name": "pypayratecode",
      "kind": "collection"
    }
  ]
}
example-1

Successful Response All Rate Codes

{
  "items": [
    {
      "RcdCode": "DOT",
      "RcdDescription": "Double Overtime",
      "RcdIuCreateDate": "2009-10-02T14:49:18-04:00",
      "RcdIuCreateUser": "DAVID2008",
      "RcdIuUpdateDate": "2025-12-22T15:29:53-05:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2025-12-22T15:29:53-05:00",
      "RcdPremMultiplier": 2,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Double Overtime",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77825E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "HOL",
      "RcdDescription": "Holiday",
      "RcdIuCreateDate": "2020-09-14T12:55:35-04:00",
      "RcdIuCreateUser": "MAHEEN",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Holiday",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78125E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "KB",
      "RcdDescription": "KB test",
      "RcdIuCreateDate": "2023-04-13T12:07:28-04:00",
      "RcdIuCreateUser": "DA",
      "RcdIuUpdateDate": null,
      "RcdIuUpdateUser": null,
      "RcdLastUpdDate": "2023-04-13T12:07:28-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Regular",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C77F25E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "NIGH",
      "RcdDescription": "Night Shift Prem",
      "RcdIuCreateDate": "2021-04-28T14:37:50-04:00",
      "RcdIuCreateUser": "IMRAN",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1.25,
      "RcdPremPerHourAmt": 1.5,
      "RcdShortDesc": "NS Premium",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78325E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "O125",
      "RcdDescription": "Overtime 1.25",
      "RcdIuCreateDate": "2021-10-23T09:27:37-04:00",
      "RcdIuCreateUser": "VERA_R",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1.25,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Overtime 1.25",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78725E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "O150",
      "RcdDescription": "Overtime 1.5",
      "RcdIuCreateDate": "2021-10-23T09:28:01-04:00",
      "RcdIuCreateUser": "VERA_R",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1.5,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Overtime 1.5",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78825E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "OT",
      "RcdDescription": "Overtime",
      "RcdIuCreateDate": "2009-10-02T14:49:18-04:00",
      "RcdIuCreateUser": "DAVID2008",
      "RcdIuUpdateDate": "2026-03-09T16:49:47-04:00",
      "RcdIuUpdateUser": "TAUSEEF",
      "RcdLastUpdDate": "2026-03-09T16:49:47-04:00",
      "RcdPremMultiplier": 1.5,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Overtime",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C77725E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "OT2",
      "RcdDescription": "Guaranteed 50",
      "RcdIuCreateDate": "2015-01-21T08:52:23-05:00",
      "RcdIuCreateUser": "ZOHREHV10X",
      "RcdIuUpdateDate": "2026-02-24T17:19:51-05:00",
      "RcdIuUpdateUser": "KARTHI",
      "RcdLastUpdDate": "2026-02-24T17:19:51-05:00",
      "RcdPremMultiplier": 1.3,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "1",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C77E25E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "OTH",
      "RcdDescription": "Other Time",
      "RcdIuCreateDate": "2020-09-14T12:28:41-04:00",
      "RcdIuCreateUser": "MAHEEN",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Other Time",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78025E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "OTHR",
      "RcdDescription": "Other",
      "RcdIuCreateDate": "2009-10-02T14:49:18-04:00",
      "RcdIuCreateUser": "DAVID2008",
      "RcdIuUpdateDate": "2025-12-22T15:29:53-05:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2025-12-22T15:29:53-05:00",
      "RcdPremMultiplier": 2.5,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Other",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77925E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "OTT",
      "RcdDescription": "OTT",
      "RcdIuCreateDate": "2024-06-27T19:33:41-04:00",
      "RcdIuCreateUser": "WALID",
      "RcdIuUpdateDate": null,
      "RcdIuUpdateUser": null,
      "RcdLastUpdDate": "2024-06-27T19:33:41-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "OTT",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C78425E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "RC01",
      "RcdDescription": "Rate Code 1",
      "RcdIuCreateDate": "2021-04-05T09:31:09-04:00",
      "RcdIuCreateUser": "MARYAM",
      "RcdIuUpdateDate": "2025-06-02T12:58:48-04:00",
      "RcdIuUpdateUser": "MARYAM",
      "RcdLastUpdDate": "2025-06-02T12:58:48-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Rate Code 1",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C78525E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "REG",
      "RcdDescription": "Regular",
      "RcdIuCreateDate": "2009-10-02T14:49:18-04:00",
      "RcdIuCreateUser": "DAVID2008",
      "RcdIuUpdateDate": "2025-10-13T18:43:36-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2025-10-13T18:43:36-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Regular",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C77625E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "STF1",
      "RcdDescription": "Step Up Pay Foreman",
      "RcdIuCreateDate": "2021-04-28T14:37:14-04:00",
      "RcdIuCreateUser": "IMRAN",
      "RcdIuUpdateDate": "2025-08-27T03:33:47-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2025-08-27T03:33:47-04:00",
      "RcdPremMultiplier": 0,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "STEP Foreman",
      "RcdUser": "UIG",
      "RcdVUuid": "27E0C1E8C78225E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "STF2",
      "RcdDescription": "Step up Foreman - proj1",
      "RcdIuCreateDate": "2021-05-26T15:37:58-04:00",
      "RcdIuCreateUser": "IMRAN",
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 3.5,
      "RcdShortDesc": "Step1",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C78625E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "TRC",
      "RcdDescription": "Test Rate Code",
      "RcdIuCreateDate": "2024-12-02T01:02:52-05:00",
      "RcdIuCreateUser": "DA",
      "RcdIuUpdateDate": "2026-03-31T10:08:20-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2026-03-31T10:08:20-04:00",
      "RcdPremMultiplier": 0.5,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "TestRateCode",
      "RcdUser": "DA",
      "RcdVUuid": "28444AEDDB716304E0630B811DAC2409"
    },
    {
      "RcdCode": "TRC1",
      "RcdDescription": "Test Rate Code1",
      "RcdIuCreateDate": "2024-12-02T01:20:05-05:00",
      "RcdIuCreateUser": "DA",
      "RcdIuUpdateDate": null,
      "RcdIuUpdateUser": null,
      "RcdLastUpdDate": "2024-12-02T01:20:05-05:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "TestRateCode1",
      "RcdUser": "DAR",
      "RcdVUuid": "28444AEDDB736304E0630B811DAC2409"
    },
    {
      "RcdCode": "Z100",
      "RcdDescription": "Regular",
      "RcdIuCreateDate": null,
      "RcdIuCreateUser": null,
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Regular",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77A25E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "Z200",
      "RcdDescription": "Overtime",
      "RcdIuCreateDate": null,
      "RcdIuCreateUser": null,
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1.5,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Overtime",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77B25E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "Z300",
      "RcdDescription": "Double Time",
      "RcdIuCreateDate": null,
      "RcdIuCreateUser": null,
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 2,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Double Time",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77C25E4E0630B811DAC6F72"
    },
    {
      "RcdCode": "Z400",
      "RcdDescription": "Other",
      "RcdIuCreateDate": null,
      "RcdIuCreateUser": null,
      "RcdIuUpdateDate": "2021-10-28T13:31:23-04:00",
      "RcdIuUpdateUser": "DA",
      "RcdLastUpdDate": "2021-10-28T13:31:23-04:00",
      "RcdPremMultiplier": 1,
      "RcdPremPerHourAmt": 0,
      "RcdShortDesc": "Other",
      "RcdUser": "DA",
      "RcdVUuid": "27E0C1E8C77D25E4E0630B811DAC6F72"
    }
  ],
  "count": 21,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://127.0.0.1:7101/hcm-rest-api/rest/1/pypayratecode",
      "name": "pypayratecode",
      "kind": "collection"
    }
  ]
}
object
Copyright © 2024 CMiC All Rights Reserved