--- title: "Create a PY Tax Override" slug: "create-a-py-tax-override" updated: 2026-05-26T12:53:14Z published: 2026-05-26T12:53:48Z canonical: "developers.cmicglobal.com/create-a-py-tax-override" --- > ## 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. # Create a PY Tax Override Post/hcm-rest-api/rest/1/pytaxemp ## Create Tax Overrrides ### SecurityHTTPType basic Basic authentication Header parametersContent-TypestringExampleapplication/vnd.oracle.adf.resourceItem+json Body parametersobject Example{ "TxpEmpNo": "801", "TxpTaxCode": "FWT", "TxpWrlCode": "ALL", "TxpStateCode": "ALL", "TxpCalcmeth": "02", "TxpEffectiveDate": "2023-01-10", "TxpLastUpdDate": "2023-01-10T21:36:53-05:00", "TxpUser": "ARCORO", "TxpVUuid": "" }TxpStateCodestring Required State Code – Must be a valid state code from the PYSTATE (STA_STATE_CODE) table or ‘ALL’ for Federal tax. Max length4 TxpCalcmethstring Required Calculation Method – This will be validated through Vertex. Max length2 TxpLastUpdDatestring Required Date when the record was last updated. TxpEmpNostring Required Employee Number – Must be a valid employee code from the PYEMPLOYEE_TABLE (EMP_NO) table. Max length16 TxpUserstring Required User who last updated this record. Max length30 TxpWrlCodestring Required Work Location Code – Must be valid values from the PYWORKLOC (WRL_CODE) table. Max length15 TxpEffectiveDatestring Required Effective Date (Starting date for the tax override) TxpTaxCodestring Required Tax Code – Must be a valid tax code from the PYTAX (TAX_CODE) table: - If the State code is ‘ALL’, then it is a Federal tax. - If using a valid State code and Work Location is ‘ALL’, then it is a State tax. - If using a valid State code and Work Location code, then it is a Local Tax. Max length4 TxpVUuidstring Required Unique uuid of row Max length64 TxpAddSuplTaxRatenumber Additional Supplementary Tax Rate – If entered, the payroll system will add this amount to the supplementary tax rate. Max length16 TxpExcludeFlagstring Exclude Tax Flag – If checked, this tax will be excluded from the employee. ‘Y’ or ‘N’ Max length1 TxpAmtTypestring Override Type 00 - Additional Tax 01 - Override Tax 02 - Month-to-Date Tax 03 - Quarter-to-date Tax 04 - Year-to-Date Tax 05 - Previous Tax 06 - Additional Supplementary Tax Amount 07 - Override Supplementary Tax Amount 08 - Month-to-Date Supplementary Tax Amount 09 - Quarter-to-Date Supplementary Tax Amount 10 - Year-to-Date Supplementary Tax Amount 11 - Current Tax 12 - Annual Tax 13 - Current Supplemental Tax 14 - Annual Supplemental Tax 15 - Year-to-Date Supplemental Tax 16 - Prior State Tax Amount 17 - Prior State Supplemental Tax Amount 18 - Semi-Annual Tax Amount 19 - Semi-Annual Supplemental Tax Amount Max length2 TxpTaxAmountnumber Tax Override Amount. Max length18 TxpJurintTypestring vertex jurinttreatment type Max length2 TxpOvrdSuplExempAmtnumber Override Supplementary Exemption Amount – If entered, the payroll system will use this as the supplementary exemption amount. Max length18 TxpIuUpdateDatestring Time Stamp when record was updated last time,Leave Blank TxpTaxTypestring Tax Type ‘R’ – Resident ‘W’ – Work ‘B’ – Both Max length1 TxpOvrdSuplTaxRatenumber Override Supplementary Tax Rate – If entered the payroll system will use this tax rate instead of the supplementary Vertex rate. Max length16 TxpIuCreateDatestring Time Stamp when record was created, Leave Blank TxpExemptFlagstring tax exempt flag (y/n/null) Max length1 TxpOvrdRglrTaxRatenumber Override Regular Tax Rate – If entered, the payroll system will use this tax rate instead of the regular Vertex rate. Max length16 TxpOvrdRglrExempAmtnumber Override Regular Exemption Amount – If entered, the payroll system will use this as the regular exemption amount. Max length18 TxpAddPrimExempAmtnumber Number of Primary Exemptions Max length18 TxpAddSuplExempAmtnumber Number of Primary Exemptions Max length18 TxpMaxWagenumber Maximum Wage Amount – The maximum wage amount that the tax will be calculated on. Max length18 TxpIuCreateUserstring User who created record,Leave Blank Max length30 TxpMaxDedOvrdAmtnumber Maximum Override Deduction Amount – The maximum deduction amount that will be taken for this tax. Max length18 TxpAltCalcCodestring Alternate Calculation Code – This will be validated through Vertex. Max length2 TxpAddRglrTaxRatenumber Additional Regular Tax Rate – If entered, the payroll system will add this amount to the regular tax rate. Max length16 Responses201 Created HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json ```json { "TxpEmpNo": "801", "TxpStateCode": "ALL", "TxpWrlCode": "ALL", "TxpTaxCode": "FWT", "TxpEffectiveDate": "2023-01-10", "TxpTaxAmount": null, "TxpAmtType": null, "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": null, "TxpUser": "ARCORO", "TxpLastUpdDate": "2023-01-11T02:36:53Z", "TxpTaxType": null, "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" } ] } ``` object