---
title: "Retrieve PY Tax"
slug: "retrieve-py-tax"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/retrieve-py-tax"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve PY Tax

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.

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

#### Primary Key

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

| Parameter | Description | Sample |
| --- | --- | --- |
| TaxCode | Tax Code | SU1R |

SecurityHTTPType basic

Basic authentication

Query parametersfinderstringExamplefindByDate;auditDate=2015-01-06
limitintegerExample500
offsetintegerExample0
totalResultsbooleanExampletrue
orderBystringExampleTaxCode:desc

Responses200

OK

HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourcecollection+json
<select class='api-response-data' aria-label='Media type'><option value='b3be9737-cd6c-4eb5-9a5c-b9e8688619f6'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='714b5b0d-0048-4508-a8bc-ae3c16e3b56c'>example-0</option>
<option value='16518cc4-a3b7-491f-af44-bd16b2f1a131'>example-1</option>
</select>example-0

Successful Response - Finder - findByDate

```json
{
  "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-22T15:52:50Z",
      "TaxIuCreateDate": "2014-05-22T15: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-22T15:52:50Z",
      "TaxIuCreateUser": "DA",
      "TaxIuUpdateDate": "2018-07-11T17: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

```json
{
  "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-22T15:52:50Z",
      "TaxIuCreateDate": "2014-05-22T15: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