Retrieve PY Tax
    • 25 Sep 2024
    • 1 Minute to read
    • Dark
      Light

    Retrieve PY Tax

    • Dark
      Light

    Article summary

    Get
    /hcm-rest-api/rest/1/pytax

    Query Standards

    Finder

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

    • Find By Date
    • Primary Key

    Find By Date

    Recommended finder parameters. Refer to Query Parameters for example.

    ParameterDescriptionSample
    auditDateCreate or Update Date Time Filter2022-12-20

    Primary Key

    This is an optional finder for querying a speciic Tax by Primary Key (Payrun code)

    ParameterDescriptionSample
    TaxCodeTax CodeSU1R
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExamplefindByDate;auditDate=2015-01-06
    limit
    integer
    Example500
    offset
    integer
    Example0
    totalResults
    boolean
    Exampletrue
    orderBy
    string
    ExampleTaxCode:desc
    Responses
    200

    OK

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

    Successful Response - Finder - findByDate

    {
      "items": [
        {
          "TaxCode": "FWT",
          "TaxDescription": "Federal Withholding Tax",
          "TaxShortDescription": "Federal Withhold",
          "TaxLevel": "F",
          "TaxLevelName": "Federal",
          "TaxGrpCode": null,
          "TaxGrpName": null,
          "TaxPaidEmplr": "N",
          "TaxJobAllocation": "N",
          "TaxDeptAllocation": "N",
          "TaxSsFlag": "N",
          "TaxCreateApVoucher": "N",
          "TaxVertexTaxid": "00",
          "TaxVertexTaxidName": "Federal Withholding Tax",
          "TaxCalcmeth": "02",
          "TaxCalcmethName": "Flat Rate",
          "TaxAltCalcCode": null,
          "TaxAltCalcName": null,
          "TaxPrintOrder": 1,
          "TaxRealVertexTaxId": "400",
          "TaxUser": "DA",
          "TaxLastUpdDate": "2014-05-22T03:52:50Z",
          "TaxIuCreateDate": "2014-05-22T03:52:50Z",
          "TaxIuCreateUser": "DA",
          "TaxIuUpdateDate": "2015-03-05T02:51:54Z",
          "TaxIuUpdateUser": "DA",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/FWT",
              "name": "pytax",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/FWT",
              "name": "pytax",
              "kind": "item"
            }
          ]
        },
        {
          "TaxCode": "STPE",
          "TaxDescription": "Oregon Tri-County Metropolitan",
          "TaxShortDescription": "Oregon Tri-Count",
          "TaxLevel": "L",
          "TaxLevelName": "Local",
          "TaxGrpCode": null,
          "TaxGrpName": null,
          "TaxPaidEmplr": "Y",
          "TaxJobAllocation": "N",
          "TaxDeptAllocation": "N",
          "TaxSsFlag": "N",
          "TaxCreateApVoucher": "N",
          "TaxVertexTaxid": "49",
          "TaxVertexTaxidName": "Oregon Tri-County Metropolitan Employer",
          "TaxCalcmeth": "02",
          "TaxCalcmethName": "Flat Rate",
          "TaxAltCalcCode": null,
          "TaxAltCalcName": null,
          "TaxPrintOrder": 1,
          "TaxRealVertexTaxId": "103",
          "TaxUser": "DA",
          "TaxLastUpdDate": "2018-07-11",
          "TaxIuCreateDate": "2014-05-22T03:52:50Z",
          "TaxIuCreateUser": "DA",
          "TaxIuUpdateDate": "2018-07-11T05:51:04Z",
          "TaxIuUpdateUser": "DA",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/STPE",
              "name": "pytax",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/STPE",
              "name": "pytax",
              "kind": "item"
            }
          ]
        }
      ],
      "count": 2,
      "hasMore": false,
      "limit": 5,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax",
          "name": "pytax",
          "kind": "collection"
        }
      ]
    }
    example-1

    Successful Response - Finder - PrimaryKey

    {
      "items": [
        {
          "TaxCode": "SU1R",
          "TaxDescription": "State Unemployment 1 ER",
          "TaxShortDescription": "State Unemployme",
          "TaxLevel": "S",
          "TaxLevelName": "State",
          "TaxGrpCode": null,
          "TaxGrpName": null,
          "TaxPaidEmplr": "Y",
          "TaxJobAllocation": "N",
          "TaxDeptAllocation": "N",
          "TaxSsFlag": "N",
          "TaxCreateApVoucher": "N",
          "TaxVertexTaxid": "101",
          "TaxVertexTaxidName": "State Unemployment 1 ER",
          "TaxCalcmeth": "02",
          "TaxCalcmethName": "Flat Rate",
          "TaxAltCalcCode": null,
          "TaxAltCalcName": null,
          "TaxPrintOrder": 1,
          "TaxRealVertexTaxId": "461",
          "TaxUser": "DA",
          "TaxLastUpdDate": "2014-05-22T03:52:50Z",
          "TaxIuCreateDate": "2014-05-22T03:52:50Z",
          "TaxIuCreateUser": "DA",
          "TaxIuUpdateDate": null,
          "TaxIuUpdateUser": null,
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/SU1R",
              "name": "pytax",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pytax/SU1R",
              "name": "pytax",
              "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/pytax",
          "name": "pytax",
          "kind": "collection"
        }
      ]
    }
    object