API Catalog

Retrieve Deduction By Code

25 Sep 2024
3 Minutes to read

Print
Dark
Light

Retrieve Deduction By Code

Updated on 25 Sep 2024
3 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/pydeduction

Query Standards

Finder

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

Find By Date
By UUID

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

By UUID

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

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

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate; auditDate=2014-12-20

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleDedCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "DedCode": "401P",
      "DedDescription": "401k Deduction %",
      "DedShortDesc": "401k Deduction %",
      "DedGrpCode": null,
      "DedGrpName": null,
      "DedType": "P",
      "DedAmount": null,
      "DedBaseCode": "401K",
      "DedBaseName": "401k Wages",
      "DedEmplrContr": "N",
      "DedJobAllocation": "N",
      "DedPriority": 1,
      "DedCfFlag": "N",
      "DedPrintOrder": 1,
      "DedCalcSeq": 2040008,
      "DedPartialCfFlag": "N",
      "DedMandatoryFlag": "N",
      "DedForDepFlag": "N",
      "DedInvoiceFlag": "N",
      "DedWrlAllocation": "N",
      "DedCreateApVoucher": "N",
      "DedExcludeFlag": "N",
      "DedLimitGrpCode": null,
      "DedLimitGrpName": null,
      "DedDeptAllocation": "N",
      "DedAllocationMethod": "DEF",
      "DedUser": "CMICUSER",
      "DedLastUpdDate": "2023-03-13T06:21:17Z",
      "DedBasecdAllocationFlag": "N",
      "DedInclPyFcBurdenCal": "N",
      "DedInclInRetropayCalcFlag": "N",
      "DedLumpSum1planFlag": "N",
      "DedIuCreateDate": "2023-03-13T06:21:17Z",
      "DedIuCreateUser": "CMICUSER",
      "DedIuUpdateDate": null,
      "DedIuUpdateUser": null,
      "DedProRatedFlag": "N",
      "DedPkgFlag": "N",
      "DedVUuid": "F6CD1E47F0434484E05316821FAC065E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/F6CD1E47F0434484E05316821FAC065E",
          "name": "pydeduction",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/F6CD1E47F0434484E05316821FAC065E",
          "name": "pydeduction",
          "kind": "item"
        }
      ]
    },
    {
      "DedCode": "401C",
      "DedDescription": "401K Catch-Up",
      "DedShortDesc": "401K Catch-Up",
      "DedGrpCode": null,
      "DedGrpName": null,
      "DedType": "P",
      "DedAmount": null,
      "DedBaseCode": "BASE",
      "DedBaseName": "Base Wage",
      "DedEmplrContr": "N",
      "DedJobAllocation": "N",
      "DedPriority": 1,
      "DedCfFlag": "N",
      "DedPrintOrder": 1,
      "DedCalcSeq": 2040004,
      "DedPartialCfFlag": null,
      "DedMandatoryFlag": "N",
      "DedForDepFlag": "Y",
      "DedInvoiceFlag": "N",
      "DedWrlAllocation": "N",
      "DedCreateApVoucher": "N",
      "DedExcludeFlag": "N",
      "DedLimitGrpCode": null,
      "DedLimitGrpName": null,
      "DedDeptAllocation": "N",
      "DedAllocationMethod": "DEF",
      "DedUser": "ADWAIT",
      "DedLastUpdDate": "2015-05-04T06:35:34Z",
      "DedBasecdAllocationFlag": "N",
      "DedInclPyFcBurdenCal": "N",
      "DedInclInRetropayCalcFlag": "N",
      "DedLumpSum1planFlag": "N",
      "DedIuCreateDate": "2015-05-04T06:35:34Z",
      "DedIuCreateUser": "ADWAIT",
      "DedIuUpdateDate": null,
      "DedIuUpdateUser": null,
      "DedProRatedFlag": null,
      "DedPkgFlag": null,
      "DedVUuid": "EE17D067EF1A139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF1A139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF1A139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        }
      ]
    },
    {
      "DedCode": "401M",
      "DedDescription": "401K - Matching",
      "DedShortDesc": "401K Match",
      "DedGrpCode": null,
      "DedGrpName": null,
      "DedType": "P",
      "DedAmount": null,
      "DedBaseCode": "BASE",
      "DedBaseName": "Base Wage",
      "DedEmplrContr": "Y",
      "DedJobAllocation": "N",
      "DedPriority": 1,
      "DedCfFlag": "N",
      "DedPrintOrder": 1,
      "DedCalcSeq": 9161,
      "DedPartialCfFlag": null,
      "DedMandatoryFlag": "N",
      "DedForDepFlag": "N",
      "DedInvoiceFlag": "N",
      "DedWrlAllocation": "N",
      "DedCreateApVoucher": "N",
      "DedExcludeFlag": "N",
      "DedLimitGrpCode": "401G",
      "DedLimitGrpName": "401K Max Limit Group",
      "DedDeptAllocation": "N",
      "DedAllocationMethod": "DEF",
      "DedUser": "ADWAIT",
      "DedLastUpdDate": "2015-05-04T06:37:01Z",
      "DedBasecdAllocationFlag": "N",
      "DedInclPyFcBurdenCal": "N",
      "DedInclInRetropayCalcFlag": "N",
      "DedLumpSum1planFlag": "N",
      "DedIuCreateDate": "2015-05-04T06:37:02Z",
      "DedIuCreateUser": "ADWAIT",
      "DedIuUpdateDate": null,
      "DedIuUpdateUser": null,
      "DedProRatedFlag": null,
      "DedPkgFlag": null,
      "DedVUuid": "EE17D067EF1D139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF1D139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF1D139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        }
      ]
    },
    {
      "DedCode": "CS01",
      "DedDescription": "Child Support",
      "DedShortDesc": "Child Support",
      "DedGrpCode": null,
      "DedGrpName": null,
      "DedType": "P",
      "DedAmount": null,
      "DedBaseCode": "BASE",
      "DedBaseName": "Base Wage",
      "DedEmplrContr": "N",
      "DedJobAllocation": "N",
      "DedPriority": 1,
      "DedCfFlag": "N",
      "DedPrintOrder": 1,
      "DedCalcSeq": 50190,
      "DedPartialCfFlag": null,
      "DedMandatoryFlag": "N",
      "DedForDepFlag": "N",
      "DedInvoiceFlag": "N",
      "DedWrlAllocation": "N",
      "DedCreateApVoucher": "Y",
      "DedExcludeFlag": "N",
      "DedLimitGrpCode": null,
      "DedLimitGrpName": null,
      "DedDeptAllocation": "N",
      "DedAllocationMethod": "DEF",
      "DedUser": "ADWAIT",
      "DedLastUpdDate": "2015-05-04T06:38:45Z",
      "DedBasecdAllocationFlag": "N",
      "DedInclPyFcBurdenCal": "N",
      "DedInclInRetropayCalcFlag": "N",
      "DedLumpSum1planFlag": "N",
      "DedIuCreateDate": "2015-05-04T06:38:45Z",
      "DedIuCreateUser": "ADWAIT",
      "DedIuUpdateDate": null,
      "DedIuUpdateUser": null,
      "DedProRatedFlag": null,
      "DedPkgFlag": null,
      "DedVUuid": "EE17D067EF21139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF21139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF21139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        }
      ]
    },
    {
      "DedCode": "DUEP",
      "DedDescription": "Field Dues Percent",
      "DedShortDesc": "Field Dues Per",
      "DedGrpCode": null,
      "DedGrpName": null,
      "DedType": "P",
      "DedAmount": null,
      "DedBaseCode": "BASE",
      "DedBaseName": "Base Wage",
      "DedEmplrContr": "N",
      "DedJobAllocation": "N",
      "DedPriority": 1,
      "DedCfFlag": "N",
      "DedPrintOrder": 1,
      "DedCalcSeq": 231,
      "DedPartialCfFlag": null,
      "DedMandatoryFlag": "N",
      "DedForDepFlag": "N",
      "DedInvoiceFlag": "N",
      "DedWrlAllocation": "N",
      "DedCreateApVoucher": "N",
      "DedExcludeFlag": "N",
      "DedLimitGrpCode": null,
      "DedLimitGrpName": null,
      "DedDeptAllocation": "N",
      "DedAllocationMethod": "DEF",
      "DedUser": "ADWAIT",
      "DedLastUpdDate": "2015-05-04T06:41:22Z",
      "DedBasecdAllocationFlag": "N",
      "DedInclPyFcBurdenCal": "N",
      "DedInclInRetropayCalcFlag": "N",
      "DedLumpSum1planFlag": "N",
      "DedIuCreateDate": "2015-05-04T06:41:22Z",
      "DedIuCreateUser": "ADWAIT",
      "DedIuUpdateDate": null,
      "DedIuUpdateUser": null,
      "DedProRatedFlag": null,
      "DedPkgFlag": null,
      "DedVUuid": "EE17D067EF25139CE05316821FACD6EE",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF25139CE05316821FACD6EE",
          "name": "pydeduction",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/EE17D067EF25139CE05316821FACD6EE",
          "name": "pydeduction",
          "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/pydeduction",
      "name": "pydeduction",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific Deduction By VUUID

Retrieve Deduction By Code

Query Standards

Finder

Find By Date

By UUID

What's Next

Contact Us