Retrieve PY Tax Overrides By Code
  • 12 Feb 2025
  • 4 Minutes to read
  • Dark
    Light

Retrieve PY Tax Overrides By Code

  • Dark
    Light

Article summary

Get
/hcm-rest-api/rest/1/pytaxemp

Query Standards

Finder

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

  • Py Tax Emp Finder
  • By UUID

Py Tax Emp Finder

Recommended finder parameters. Refer to Query Parameters for example.

ParameterDescriptionSample
WrlCodeVarWork Location CodeALL
StatecodeVarState CodeALL
EmpNoVarEmployee Number800
TaxCodeVarTax CodeEWT

By UUID

This is an optional finder for querying a specific Tax Override by row ID.

ParameterDescriptionSample
/VUUIDThe VUuid attribute is the Unique row ID/hcm-rest-api/rest/1/pytaxemp/:F1F4D8C9D75114C5E05316821FAC45C9
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExamplePyTaxEmpFinder; WrlCodeVar=ALL, StatecodeVar=ALL,EmpNoVar=800, TaxCodeVar=EWT
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
ExampleTrue
orderBy
string
ExampleTxpVUuid:desc
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
  "items": [
    {
      "TxpEmpNo": "007",
      "TxpStateCode": "AK",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "SM1E",
      "TxpEffectiveDate": "2022-12-01",
      "TxpTaxAmount": 100,
      "TxpAmtType": "04",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2022-11-30T15:18:18Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "EEB29D40D3B35D1FE05316821FAC916A",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/EEB29D40D3B35D1FE05316821FAC916A",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/EEB29D40D3B35D1FE05316821FAC916A",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "800",
      "TxpStateCode": "ALL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "FWT",
      "TxpEffectiveDate": "2023-01-10",
      "TxpTaxAmount": 50,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-11T02:36:53Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F1F4D8C9D75114C5E05316821FAC45C9",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1F4D8C9D75114C5E05316821FAC45C9",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1F4D8C9D75114C5E05316821FAC45C9",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "800",
      "TxpStateCode": "AZ",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "STAT",
      "TxpEffectiveDate": "2023-01-03",
      "TxpTaxAmount": null,
      "TxpAmtType": null,
      "TxpCalcmeth": "00",
      "TxpAltCalcCode": "23",
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-03T22:11:45Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F1645A7C1C814D54E05316821FAC1C7E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1645A7C1C814D54E05316821FAC1C7E",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1645A7C1C814D54E05316821FAC1C7E",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "800",
      "TxpStateCode": "IA",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "STAT",
      "TxpEffectiveDate": "2023-01-03",
      "TxpTaxAmount": null,
      "TxpAmtType": "01",
      "TxpCalcmeth": "00",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": 50,
      "TxpOvrdSuplExempAmt": 100,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "Y",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-11T17:25:22Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F1645A7C1C824D54E05316821FAC1C7E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1645A7C1C824D54E05316821FAC1C7E",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F1645A7C1C824D54E05316821FAC1C7E",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "801",
      "TxpStateCode": "AL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "STAT",
      "TxpEffectiveDate": "2023-01-11",
      "TxpTaxAmount": null,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-25T20:37:03Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F209E34CF62F280CE05316821FACB588",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F209E34CF62F280CE05316821FACB588",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F209E34CF62F280CE05316821FACB588",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "801",
      "TxpStateCode": "ALL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "FWT",
      "TxpEffectiveDate": "2023-01-10",
      "TxpTaxAmount": null,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": 25000,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-25T20:37:03Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F2A6825A90AF617EE05316821FAC03A9",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2A6825A90AF617EE05316821FAC03A9",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2A6825A90AF617EE05316821FAC03A9",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "801",
      "TxpStateCode": "ALL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "FWT",
      "TxpEffectiveDate": "2023-01-12",
      "TxpTaxAmount": 0,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-25T20:37:03Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F31A71AB517C409BE05316821FAC5E4B",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F31A71AB517C409BE05316821FAC5E4B",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F31A71AB517C409BE05316821FAC5E4B",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "801",
      "TxpStateCode": "ALL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "FWT",
      "TxpEffectiveDate": "2023-01-25",
      "TxpTaxAmount": null,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-25T20:38:01Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F31D8C7276340FF2E05316821FAC6ABD",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F31D8C7276340FF2E05316821FAC6ABD",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F31D8C7276340FF2E05316821FAC6ABD",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "801",
      "TxpStateCode": "CA",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "STAT",
      "TxpEffectiveDate": "2023-01-12",
      "TxpTaxAmount": null,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-25T20:37:03Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F2162A283692498EE05316821FAC6A9A",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2162A283692498EE05316821FAC6A9A",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2162A283692498EE05316821FAC6A9A",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    },
    {
      "TxpEmpNo": "809",
      "TxpStateCode": "ALL",
      "TxpWrlCode": "ALL",
      "TxpTaxCode": "FWT",
      "TxpEffectiveDate": "2023-01-19",
      "TxpTaxAmount": 150,
      "TxpAmtType": "00",
      "TxpCalcmeth": "02",
      "TxpAltCalcCode": null,
      "TxpAddPrimExempAmt": null,
      "TxpAddSuplExempAmt": null,
      "TxpOvrdRglrTaxRate": null,
      "TxpOvrdSuplTaxRate": null,
      "TxpAddRglrTaxRate": null,
      "TxpAddSuplTaxRate": null,
      "TxpOvrdRglrExempAmt": null,
      "TxpOvrdSuplExempAmt": null,
      "TxpMaxWage": null,
      "TxpMaxDedOvrdAmt": null,
      "TxpExcludeFlag": "N",
      "TxpUser": "ARCORO",
      "TxpLastUpdDate": "2023-01-19T17:50:55Z",
      "TxpTaxType": "B",
      "TxpJurintType": null,
      "TxpExemptFlag": null,
      "TxpVUuid": "F2A26A222DBD77E5E05316821FAC2319",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2A26A222DBD77E5E05316821FAC2319",
          "name": "pytaxemp",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp/F2A26A222DBD77E5E05316821FAC2319",
          "name": "pytaxemp",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 10,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxemp",
      "name": "pytaxemp",
      "kind": "collection"
    }
  ]
}
object