API Catalog

Retrieve Company Deduction Codes By Code

06 Jan 2025
6 Minutes to read

Print
Dark
Light

Retrieve Company Deduction Codes By Code

Updated on 06 Jan 2025
6 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/pycomded

Query Standards

Finder

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

Find By Keys
Find By Date
By UUID

Find By Keys

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
payRun	Payrun Code (Frequency)	SM
compCode	Company Code	001
payGroup	Pay Group Code	NONE

Find By Date

This is an optional finder for querying Company Deductions by Audit Date.

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

By UUID

This is an optional finder for querying a specific Company Deduction by its Row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/hcm-rest-api/rest/1/pycomded/EE17D0682871139CE05316821FACD6EE

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByKeys;payRun=1, compCode=001, payGroup=NONE

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleCodDedCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - FInder - findByDate

{
  "items": [
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 3,
      "CodDedAmount": 1,
      "CodEmplrContrFactor": "Y",
      "CodContrAmt": 1,
      "CodContrMaxAmt": 1,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86800",
      "CodEmplrContrAccName": "401(K) Matching Contribution",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": "Company Level",
      "CodEmplrContrDeptCode": "00",
      "CodEmplrContrDeptName": "Company Level",
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 1%",
      "CodPloName": "401K 1%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "SM",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "Y",
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": "P",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 3,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "Y",
      "CodUser": "FIELDPOINT",
      "CodLastUpdDate": "2022-11-03T14:50:15Z",
      "CodIuCreateDate": "2015-05-04T19:56:26Z",
      "CodIuCreateUser": "ADWAIT",
      "CodIuUpdateDate": "2022-11-03T14:50:15Z",
      "CodIuUpdateUser": "FIELDPOINT",
      "CodEmplrContr": "N",
      "CodVUuid": "EE17D0682870139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682870139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682870139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 1,
      "CodDedAmount": 1,
      "CodEmplrContrFactor": "Y",
      "CodContrAmt": 1,
      "CodContrMaxAmt": 1,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86800",
      "CodEmplrContrAccName": "401(K) Matching Contribution",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": "Company Level",
      "CodEmplrContrDeptCode": "00",
      "CodEmplrContrDeptName": "Company Level",
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 1%",
      "CodPloName": "401K 1%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "WK",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "N",
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": "P",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 1,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "N",
      "CodUser": "SMARTBARREL",
      "CodLastUpdDate": "2023-01-23T16:35:48Z",
      "CodIuCreateDate": "2015-05-04T19:51:23Z",
      "CodIuCreateUser": "ADWAIT",
      "CodIuUpdateDate": "2023-01-23T16:35:48Z",
      "CodIuUpdateUser": "SMARTBARREL",
      "CodEmplrContr": "N",
      "CodVUuid": "EE17D068286F139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D068286F139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D068286F139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 3,
      "CodDedAmount": 2,
      "CodEmplrContrFactor": "Y",
      "CodContrAmt": 0.5,
      "CodContrMaxAmt": 5,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86800",
      "CodEmplrContrAccName": "401(K) Matching Contribution",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": "Company Level",
      "CodEmplrContrDeptCode": "00",
      "CodEmplrContrDeptName": "Company Level",
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 2-5%",
      "CodPloName": "401K 2-5%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "SM",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "Y",
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": "P",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 3,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "Y",
      "CodUser": "FIELDPOINT",
      "CodLastUpdDate": "2022-11-03T14:50:15Z",
      "CodIuCreateDate": "2015-05-04T19:58:12Z",
      "CodIuCreateUser": "ADWAIT",
      "CodIuUpdateDate": "2022-11-03T14:50:15Z",
      "CodIuUpdateUser": "FIELDPOINT",
      "CodEmplrContr": "N",
      "CodVUuid": "EE17D0682871139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682871139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682871139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 1,
      "CodDedAmount": 2,
      "CodEmplrContrFactor": "Y",
      "CodContrAmt": 0.5,
      "CodContrMaxAmt": 5,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86800",
      "CodEmplrContrAccName": "401(K) Matching Contribution",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": "Company Level",
      "CodEmplrContrDeptCode": "00",
      "CodEmplrContrDeptName": "Company Level",
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 2-5%",
      "CodPloName": "401K 2-5%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "WK",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "N",
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": "P",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 1,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "N",
      "CodUser": "SMARTBARREL",
      "CodLastUpdDate": "2023-01-23T16:35:48Z",
      "CodIuCreateDate": "2015-05-04T19:52:47Z",
      "CodIuCreateUser": "ADWAIT",
      "CodIuUpdateDate": "2023-01-23T16:35:48Z",
      "CodIuUpdateUser": "SMARTBARREL",
      "CodEmplrContr": "N",
      "CodVUuid": "EE17D068286C139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D068286C139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D068286C139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": "DI",
      "CodBaseName": "Disposable Income",
      "CodDedCode": "CS01",
      "CodDedName": "Child Support",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 3,
      "CodDedAmount": 0,
      "CodEmplrContrFactor": "N",
      "CodContrAmt": null,
      "CodContrMaxAmt": null,
      "CodGlAccCode": "20122",
      "CodGlAccName": "Accrued Garnishments",
      "CodEmplrContrAccCode": null,
      "CodEmplrContrAccName": null,
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": "Company Level",
      "CodEmplrContrDeptCode": "00",
      "CodEmplrContrDeptName": "Company Level",
      "CodDedType": "P",
      "CodPlanCode": "DEFAULT",
      "CodPlanName": "DEFAULT PLAN",
      "CodPloCode": "DEFAULT",
      "CodPloName": "Default",
      "CodVendor": "AOC001",
      "CodVenName": "Administrative Office of the Court",
      "CodCompCode": "001",
      "CodPrnCode": "SM",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "Y",
      "CodCalcAfterFirstChkFlag": null,
      "CodContrMaxType": "F",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 3,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "Y",
      "CodUser": "ADWAIT",
      "CodLastUpdDate": "2015-05-04T20:00:33Z",
      "CodIuCreateDate": "2015-05-04T20:00:33Z",
      "CodIuCreateUser": "ADWAIT",
      "CodIuUpdateDate": null,
      "CodIuUpdateUser": null,
      "CodEmplrContr": "N",
      "CodVUuid": "EE17D0682872139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682872139CE05316821FACD6EE",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/EE17D0682872139CE05316821FACD6EE",
          "name": "pycomded",
          "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/pycomded",
      "name": "pycomded",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - FInder - findByKeys

{
  "items": [
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction LS",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 1,
      "CodDedAmount": 1,
      "CodEmplrContrFactor": "N",
      "CodContrAmt": null,
      "CodContrMaxAmt": null,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86600",
      "CodEmplrContrAccName": "Employment Expenses",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": null,
      "CodEmplrContrDeptCode": null,
      "CodEmplrContrDeptName": null,
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 1%",
      "CodPloName": "401K 1%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "1",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "N",
      "CodCalcAfterFirstChkFlag": "N",
      "CodContrMaxType": null,
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 2,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "N",
      "CodUser": "ARCORO",
      "CodLastUpdDate": "2023-08-24T12:54:36Z",
      "CodIuCreateDate": "2023-01-26T20:18:04Z",
      "CodIuCreateUser": "ARCORO",
      "CodIuUpdateDate": "2023-08-24T12:54:36Z",
      "CodIuUpdateUser": "ARCORO",
      "CodEmplrContr": "N",
      "CodVUuid": "F331387931922F59E05316821FACD861",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F331387931922F59E05316821FACD861",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F331387931922F59E05316821FACD861",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "401K",
      "CodDedName": "401K Deduction LS",
      "CodStartDate": "2015-01-01",
      "CodEndDate": null,
      "CodFrqCode": 1,
      "CodDedAmount": 2,
      "CodEmplrContrFactor": "N",
      "CodContrAmt": null,
      "CodContrMaxAmt": null,
      "CodGlAccCode": "23510",
      "CodGlAccName": "401(k) Payable",
      "CodEmplrContrAccCode": "86600",
      "CodEmplrContrAccName": "Employment Expenses",
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": null,
      "CodEmplrContrDeptCode": null,
      "CodEmplrContrDeptName": null,
      "CodDedType": "L",
      "CodPlanCode": "401K",
      "CodPlanName": "401K",
      "CodPloCode": "401K 2-5%",
      "CodPloName": "401K 2-5%",
      "CodVendor": "0001-10-01T00:00:00Z",
      "CodVenName": "Sun Life Group",
      "CodCompCode": "001",
      "CodPrnCode": "1",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "N",
      "CodCalcAfterFirstChkFlag": "N",
      "CodContrMaxType": null,
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": null,
      "CodRemittanceFrqCode": 2,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "N",
      "CodUser": "ARCORO",
      "CodLastUpdDate": "2023-08-24T12:54:36Z",
      "CodIuCreateDate": "2023-01-26T20:18:04Z",
      "CodIuCreateUser": "ARCORO",
      "CodIuUpdateDate": "2023-08-24T12:54:36Z",
      "CodIuUpdateUser": "ARCORO",
      "CodEmplrContr": "N",
      "CodVUuid": "F331387931952F59E05316821FACD861",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F331387931952F59E05316821FACD861",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F331387931952F59E05316821FACD861",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    },
    {
      "CodElegAmt": null,
      "CodElegBaseCode": null,
      "CodBaseCode": null,
      "CodBaseName": null,
      "CodDedCode": "MED",
      "CodDedName": "Medical",
      "CodStartDate": "2023-01-01",
      "CodEndDate": null,
      "CodFrqCode": 7,
      "CodDedAmount": 0,
      "CodEmplrContrFactor": "N",
      "CodContrAmt": null,
      "CodContrMaxAmt": null,
      "CodGlAccCode": "10002",
      "CodGlAccName": "Bank - $USD Payroll Account",
      "CodEmplrContrAccCode": null,
      "CodEmplrContrAccName": null,
      "CodElegFrqCode": null,
      "CodDeptCode": null,
      "CodDeptName": null,
      "CodEmplrContrDeptCode": null,
      "CodEmplrContrDeptName": null,
      "CodDedType": "L",
      "CodPlanCode": "DEFAULT",
      "CodPlanName": "DEFAULT PLAN",
      "CodPloCode": "DEFAULT",
      "CodPloName": "Default",
      "CodVendor": null,
      "CodVenName": null,
      "CodCompCode": "001",
      "CodPrnCode": "1",
      "CodPygCode": "NONE",
      "CodPrintDedFlag": "Y",
      "CodCalcAfterFirstChkFlag": "N",
      "CodContrMaxType": "F",
      "CodEmplrContrEffectiveDate": null,
      "CodComment": null,
      "CodRemittanceAmtForAp": "N",
      "CodRemittanceFrqCode": 7,
      "CodRemittanceTotAmt": null,
      "CodDedSecureFlag": "Y",
      "CodUser": "ARCORO",
      "CodLastUpdDate": "2023-03-16T19:55:39Z",
      "CodIuCreateDate": "2023-03-16T19:55:39Z",
      "CodIuCreateUser": "ARCORO",
      "CodIuUpdateDate": null,
      "CodIuUpdateUser": null,
      "CodEmplrContr": "N",
      "CodVUuid": "F70ACAE7AAAE0C56E05316821FACB323",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F70ACAE7AAAE0C56E05316821FACB323",
          "name": "pycomded",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded/F70ACAE7AAAE0C56E05316821FACB323",
          "name": "pycomded",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomded",
      "name": "pycomded",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific Company Deduction

Retrieve Company Deduction Codes By Code

Query Standards

Finder

Find By Keys

Find By Date

By UUID

What's Next

Contact Us