Retrieve PY Job Pay Groups By Code
  • 27 Feb 2025
  • 6 Minutes to read
  • Dark
    Light

Retrieve PY Job Pay Groups By Code

  • Dark
    Light

Article summary

Get
/hcm-rest-api/rest/1/pypaygroup

Query Standards

Finder

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

  • Find By Date
  • Find By Company
  • Primary Key

Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

ParameterDescriptionSample
auditDateCreate or Update Date Time Filter2022-12-20

Find By Company

This is an optional finder for querying Pay Groups by Company Code.

ParameterDescriptionSample
compCodeCompany Code001

Primary Key

This is an optional finder for querying a specific Pay Group by Primary Key (Combination of attributes)

ParameterDescriptionSample
PygCompCodeCompany Code001
PygCodePay Group Code1
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
ExamplePygCode:desc
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
example-0

Successful Response - Finder - findByDate

{
  "items": [
    {
      "PygCompCode": "001",
      "PygCode": "CON",
      "PygDescription": "CONTRACTOR",
      "PygShortDesc": "CONTRACTOR",
      "PygBankCode": "BOA",
      "PygBranchCode": "NA",
      "PygBankAccNumber": "800000008",
      "PygCrAccCode": "10004",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:02:05Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2015-04-30T20:05:36Z",
      "PygIuUpdateUser": "ADWAIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/00020000000330303100000003434F4E",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/00020000000330303100000003434F4E",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "EXEC",
      "PygDescription": "EXECUTIVES",
      "PygShortDesc": "EXECUTIVES",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "Y",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:02:40Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2015-04-30T20:03:34Z",
      "PygIuUpdateUser": "ADWAIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "HRLY",
      "PygDescription": "HOURLY EMPLOYEES",
      "PygShortDesc": "HOURLY",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "BILL",
      "PygLastUpdDate": "2019-01-16",
      "PygDeptCode": "00",
      "PygSignFile1": "/attachments/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_SIGN_FILE1/43571358/Signature1.bmp",
      "PygSignFile2": "/attachments/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_SIGN_FILE2/43571358/Signature2.bmp",
      "PygCompanyLogoFile": "/attachments/produpg/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_COMPANY_LOGO_FILE/43571358/Trumbull_Logo.jpg",
      "PygPrintAddressFlag": "Y",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": "2",
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:04:22Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2020-05-09T21:34:19Z",
      "PygIuUpdateUser": "SYS",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000448524C59",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000448524C59",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "SAL",
      "PygDescription": "SALARY EMPLOYEES",
      "PygShortDesc": "SALARY",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30T20:06:15Z",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "Y",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:06:15Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": null,
      "PygIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000353414C",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000353414C",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "VEN",
      "PygDescription": "VENDOR",
      "PygShortDesc": "VENDOR",
      "PygBankCode": "BOA",
      "PygBranchCode": "NA",
      "PygBankAccNumber": "800000008",
      "PygCrAccCode": "10004",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30T20:06:36Z",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:06:36Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": null,
      "PygIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000356454E",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000356454E",
          "name": "pypaygroup",
          "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/pypaygroup",
      "name": "pypaygroup",
      "kind": "collection"
    }
  ]
}
example-1

Successful Response - Finder - findByCompany

{
  "items": [
    {
      "PygCompCode": "001",
      "PygCode": "CON",
      "PygDescription": "CONTRACTOR",
      "PygShortDesc": "CONTRACTOR",
      "PygBankCode": "BOA",
      "PygBranchCode": "NA",
      "PygBankAccNumber": "800000008",
      "PygCrAccCode": "10004",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:02:05Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2015-04-30T20:05:36Z",
      "PygIuUpdateUser": "ADWAIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/00020000000330303100000003434F4E",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/00020000000330303100000003434F4E",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "EXEC",
      "PygDescription": "EXECUTIVES",
      "PygShortDesc": "EXECUTIVES",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "Y",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:02:40Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2015-04-30T20:03:34Z",
      "PygIuUpdateUser": "ADWAIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "HRLY",
      "PygDescription": "HOURLY EMPLOYEES",
      "PygShortDesc": "HOURLY",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "BILL",
      "PygLastUpdDate": "2019-01-16",
      "PygDeptCode": "00",
      "PygSignFile1": "/attachments/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_SIGN_FILE1/43571358/Signature1.bmp",
      "PygSignFile2": "/attachments/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_SIGN_FILE2/43571358/Signature2.bmp",
      "PygCompanyLogoFile": "/attachments/produpg/RESOURCES/VF389BTEQP11127/PYCOMPAYGRP.PYG_COMPANY_LOGO_FILE/43571358/Trumbull_Logo.jpg",
      "PygPrintAddressFlag": "Y",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": "2",
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:04:22Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2020-05-09T21:34:19Z",
      "PygIuUpdateUser": "SYS",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000448524C59",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000448524C59",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "SAL",
      "PygDescription": "SALARY EMPLOYEES",
      "PygShortDesc": "SALARY",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30T20:06:15Z",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "Y",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:06:15Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": null,
      "PygIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000353414C",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000353414C",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    },
    {
      "PygCompCode": "001",
      "PygCode": "VEN",
      "PygDescription": "VENDOR",
      "PygShortDesc": "VENDOR",
      "PygBankCode": "BOA",
      "PygBranchCode": "NA",
      "PygBankAccNumber": "800000008",
      "PygCrAccCode": "10004",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30T20:06:36Z",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "N",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:06:36Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": null,
      "PygIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000356454E",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000356454E",
          "name": "pypaygroup",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup",
      "name": "pypaygroup",
      "kind": "collection"
    }
  ]
}
example-2

Successful Response - Finder - PrimaryKey

{
  "items": [
    {
      "PygCompCode": "001",
      "PygCode": "EXEC",
      "PygDescription": "EXECUTIVES",
      "PygShortDesc": "EXECUTIVES",
      "PygBankCode": "BOA",
      "PygBranchCode": "NY",
      "PygBankAccNumber": "100100987",
      "PygCrAccCode": "10002",
      "PygUser": "ADWAIT",
      "PygLastUpdDate": "2015-04-30",
      "PygDeptCode": "00",
      "PygSignFile1": null,
      "PygSignFile2": null,
      "PygCompanyLogoFile": null,
      "PygPrintAddressFlag": "N",
      "PygSecureFlag": "Y",
      "PygAmtForManualSign": null,
      "PygAmtForTwoSign": null,
      "PygMessage": null,
      "PygDirectDepSepAccFlag": "N",
      "PygDdBankCode": null,
      "PygDdBranchCode": null,
      "PygDdBankAccNumber": null,
      "PygDdCrAccCode": null,
      "PygDdDeptCode": null,
      "PygOvtmruleMethod": null,
      "PygSecurePayRate": "N",
      "PygUniqueSsnIgnoreFlag": "N",
      "PygOtDotChecksFlag": null,
      "PygIuCreateDate": "2015-04-30T20:02:40Z",
      "PygIuCreateUser": "ADWAIT",
      "PygIuUpdateDate": "2015-04-30T20:03:34Z",
      "PygIuUpdateUser": "ADWAIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pypaygroup/0002000000033030310000000445584543",
          "name": "pypaygroup",
          "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/pypaygroup",
      "name": "pypaygroup",
      "kind": "collection"
    }
  ]
}
object