Retrieve PY Tax Exemptions By Code
    • 19 Jun 2024
    • 4 Minutes to read
    • Dark
      Light

    Retrieve PY Tax Exemptions By Code

    • Dark
      Light

    Article summary

    Get
    /hcm-rest-api/rest/1/pytaxexm

    Query Standards

    Finder

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

    • Py Tax Exemption Finder
    • By UUID

    Py Tax Exemption Finder

    Recommended finder parameters. Refer to Query Parameters for example.

    ParameterDescriptionSample
    EmpNoVarEmployee Number804
    StateCodeVarState CodeALL

    By UUID

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

    ParameterDescriptionSample
    /VUUIDThe VUuid attribute is the Unique row ID/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC02D24E05316821FAC3DA5
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExamplePyTaxExmFinder; EmpNoVar=804,StateCodeVar=ALL
    limit
    integer
    Example500
    offset
    integer
    Example0
    totalResults
    boolean
    Exampletrue
    orderBy
    string
    ExampleTxxVUuid:desc
    Responses
    200

    OK

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourcecollection+json
    {
      "items": [
        {
          "TxxEmpNo": "800",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-10",
          "TxxFilingStatus": "16",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-11T02:35:00Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": 4500,
          "TxxOtherIncomeAmt": 12000,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F1F4D8C9D74F14C5E05316821FAC45C9",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F1F4D8C9D74F14C5E05316821FAC45C9",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F1F4D8C9D74F14C5E05316821FAC45C9",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "801",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-12",
          "TxxFilingStatus": "01",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-25T07:57:32Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2162A283693498EE05316821FAC6A9A",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2162A283693498EE05316821FAC6A9A",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2162A283693498EE05316821FAC6A9A",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "802",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "62",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:39:27Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": 4500,
          "TxxOtherIncomeAmt": 12000,
          "TxxOtherDeductionAmt": 500,
          "TxxVUuid": "F2A26A222DBB77E5E05316821FAC2319",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A26A222DBB77E5E05316821FAC2319",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A26A222DBB77E5E05316821FAC2319",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "803",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "62",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:41:16Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": 4500,
          "TxxOtherIncomeAmt": 12000,
          "TxxOtherDeductionAmt": 500,
          "TxxVUuid": "F2A1F6A62DBF2D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DBF2D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DBF2D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "804",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "16",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:42:15Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": 2000,
          "TxxOtherIncomeAmt": 6000,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC02D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC02D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC02D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "805",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2022-01-19",
          "TxxFilingStatus": "01",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "CMICUSER",
          "TxxLastUpdDate": "2023-01-19T09:59:21Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": 2000,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A4A14B8AB07A24E05316821FACC292",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A4A14B8AB07A24E05316821FACC292",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A4A14B8AB07A24E05316821FACC292",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "805",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "01",
          "TxxNrCertificate": "N",
          "TxxExempAmount": null,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:42:55Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC12D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC12D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC12D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "806",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "01",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 100,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": 1,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:44:06Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC22D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC22D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC22D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "807",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "01",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 100,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:44:22Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC32D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC32D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC32D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "808",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "02",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 100,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": null,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:44:45Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC42D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC42D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC42D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "809",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-17",
          "TxxFilingStatus": "16",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 250,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": 1,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-24T10:18:18Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A5CD6F8FB647D0E05316821FACEF84",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A5CD6F8FB647D0E05316821FACEF84",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A5CD6F8FB647D0E05316821FACEF84",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "809",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "02",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 150,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": 1,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-19T05:47:55Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "N",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A26A222DBC77E5E05316821FAC2319",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A26A222DBC77E5E05316821FAC2319",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A26A222DBC77E5E05316821FAC2319",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        },
        {
          "TxxEmpNo": "810",
          "TxxStateCode": "ALL",
          "TxxEffectiveDate": "2023-01-19",
          "TxxFilingStatus": "02",
          "TxxNrCertificate": "N",
          "TxxExempAmount": 150,
          "TxxSuplExpAmount": null,
          "TxxPrimExemp": 1,
          "TxxSecnExemp": null,
          "TxxTertExemp": null,
          "TxxUser": "ARCORO",
          "TxxLastUpdDate": "2023-01-24T10:14:59Z",
          "TxxWrlCode": "ALL",
          "TxxResidenceLocCode": null,
          "TxxPrimWorkLocCode": null,
          "TxxMultiJobsFlag": "Y",
          "TxxDepTaxCreditAmt": null,
          "TxxOtherIncomeAmt": null,
          "TxxOtherDeductionAmt": null,
          "TxxVUuid": "F2A1F6A62DC52D24E05316821FAC3DA5",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC52D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm/F2A1F6A62DC52D24E05316821FAC3DA5",
              "name": "pytaxexm",
              "kind": "item"
            }
          ]
        }
      ],
      "count": 13,
      "hasMore": false,
      "limit": 25,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytaxexm",
          "name": "pytaxexm",
          "kind": "collection"
        }
      ]
    }
    object