> ## 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

> ## Create Tax Overrrides

###

## OpenAPI

````json POST /hcm-rest-api/rest/1/pytaxemp
{
  "openapi": "3.0.0",
  "info": {
    "title": "API Catalog",
    "description": "",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://mobtest.cmiccloudr12.com/cmictestrti",
      "description": "CMIC API Server"
    }
  ],
  "security": [
    {
      "cmicBasicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Highlights"
    },
    {
      "name": "Asset Management | Equipment"
    },
    {
      "name": "Asset  Management | Fixed Assets"
    },
    {
      "name": "Asset Management | Purchase Order"
    },
    {
      "name": "Asset Management | Inventory"
    },
    {
      "name": "Asset Management | Requisition"
    },
    {
      "name": "Asset Management | Purchase Change Order"
    },
    {
      "name": "Bim Model"
    },
    {
      "name": "Bim Model Revision"
    },
    {
      "name": "Bim Tag Model"
    },
    {
      "name": "Bim Tags"
    },
    {
      "name": "Bim FileUpload Jersey"
    },
    {
      "name": "Core System | Business Partners"
    },
    {
      "name": "Core System | Business Partner Addresses"
    },
    {
      "name": "Core System | Bank"
    },
    {
      "name": "Core System | Currency"
    },
    {
      "name": "Core System | Exchange Rates"
    },
    {
      "name": "Core System | Global  Table Text Codes"
    },
    {
      "name": "Core System | Global Table  Regions"
    },
    {
      "name": "Core System | Terms"
    },
    {
      "name": "Core System | System Contact"
    },
    {
      "name": "Core System | Weight Measures"
    },
    {
      "name": "Core System | Field User Defined Classifiers"
    },
    {
      "name": "Core System | User Defined Classifiers by Object"
    },
    {
      "name": "Core System | User Extension Definitions by Object"
    },
    {
      "name": "Core System | User Extention Field Data Value"
    },
    {
      "name": "Core System | User Extension Values by Object"
    },
    {
      "name": "Core System | User System Role"
    },
    {
      "name": "Core System | User Project Role"
    },
    {
      "name": "Core System | Documents by Object"
    },
    {
      "name": "Core System | Audit Status Log by Object"
    },
    {
      "name": "Core System | Licensed Users"
    },
    {
      "name": "Core System | Company Access"
    },
    {
      "name": "Core System |  Copy User Settings"
    },
    {
      "name": "Core System | User Maintenance"
    },
    {
      "name": "Core System | User Roles"
    },
    {
      "name": "Core System | Security Groups"
    },
    {
      "name": "Core System | Job/Project Security"
    },
    {
      "name": "Core System | Weight Measure with Conversions Code"
    },
    {
      "name": "Core System | Weight Measure Conversions Code"
    },
    {
      "name": "Core System | User-defined-fields"
    },
    {
      "name": "Core System | User-extension"
    },
    {
      "name": "ECM and Workflow | Image Manager"
    },
    {
      "name": "Financials | General Ledger"
    },
    {
      "name": "Financials | Accounts Payable"
    },
    {
      "name": "Financials | Accounts Receivable"
    },
    {
      "name": "Preventative Maintenance | Issue Work Orders"
    },
    {
      "name": "Preventative Maintenance | Issue Work Items"
    },
    {
      "name": "Preventative Maintenance | Issue Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Issue Priorities"
    },
    {
      "name": "Preventative Maintenance | Issue Status"
    },
    {
      "name": "Preventative Maintenance | Issue Types"
    },
    {
      "name": "Preventative Maintenance | Accumulative Equipment"
    },
    {
      "name": "Preventative Maintenance | Work Orders"
    },
    {
      "name": "Preventative Maintenance | Work Items"
    },
    {
      "name": "Preventative Maintenance | Work Budgets"
    },
    {
      "name": "Preventative Maintenance | Priorities"
    },
    {
      "name": "Preventative Maintenance | Tasks"
    },
    {
      "name": "HCM | UKG Pay Deductions"
    },
    {
      "name": "HCM | UKG Pay Earnings"
    },
    {
      "name": "HCM | UKG Pay Headers"
    },
    {
      "name": "HCM | UKG Pay Taxes"
    },
    {
      "name": "HCM | Payroll Geographical States"
    },
    {
      "name": "HCM | Payroll Trades"
    },
    {
      "name": "HCM | Payroll Union"
    },
    {
      "name": "HCM | Payroll Pay Runs"
    },
    {
      "name": "HCM | Payroll Pay Groups"
    },
    {
      "name": "HCM | Payroll Tax"
    },
    {
      "name": "HCM | Payroll Worker Compensation"
    },
    {
      "name": "HCM | Payroll Work Locations"
    },
    {
      "name": "HCM | Payroll Trade Pay Rates"
    },
    {
      "name": "HCM | Payroll Union Pay Rates"
    },
    {
      "name": "HCM | Payroll Job Pay Rates"
    },
    {
      "name": "HCM | Payroll Master Benefits"
    },
    {
      "name": "HCM | Payroll Master Deductions"
    },
    {
      "name": "HCM | Payroll Ben/Ded/Leave Base Codes"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plans"
    },
    {
      "name": "HCM | Payroll Ben/Ded Plan Options"
    },
    {
      "name": "HCM | Payroll Company Benefits"
    },
    {
      "name": "HCM | Payroll Company Deductions"
    },
    {
      "name": "HCM | Payroll Vertex Geographic Locations"
    },
    {
      "name": "HCM | Payroll Checks"
    },
    {
      "name": "HCM | Payroll Timesheets"
    },
    {
      "name": "HCM | Employee"
    },
    {
      "name": "HCM | Employee (Minimum payload)"
    },
    {
      "name": "HCM | Employee History"
    },
    {
      "name": "HCM | Tax Exemptions"
    },
    {
      "name": "HCM | Employee Tax Overrides"
    },
    {
      "name": "HCM | Employee Pay Splits"
    },
    {
      "name": "HCM | Employee Benefits"
    },
    {
      "name": "HCM | Employee Clock In and Out"
    },
    {
      "name": "HCM | Employee Deductions"
    },
    {
      "name": "HCM | Employee Leaves"
    },
    {
      "name": "HCM | Employee Leave History"
    },
    {
      "name": "HCM | Employee Hour Types"
    },
    {
      "name": "HCM | Employee Pay History"
    },
    {
      "name": "HCM | Employee Work Statuses"
    },
    {
      "name": "HCM | Employee Security Group"
    },
    {
      "name": "HCM | Crewtime Crew"
    },
    {
      "name": "HCM | Crewtime Employee Timesheet"
    },
    {
      "name": "HCM | Crewtime Equipment Timesheet"
    },
    {
      "name": "HCM | Crew Maintenance Activity Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Member Trade and Union Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Assignment"
    },
    {
      "name": "HCM | Crew Maintenance Equipment Detail Assignment"
    },
    {
      "name": "HCM | HR Requisitions"
    },
    {
      "name": "HCM | HR Relations"
    },
    {
      "name": "HCM | HR Employee Skills"
    },
    {
      "name": "HCM | HR Incident"
    },
    {
      "name": "HCM | HR Employee Relatives / Dependents"
    },
    {
      "name": "HCM | HR Employee Positions"
    },
    {
      "name": "HCM | HR Applicants"
    },
    {
      "name": "HCM | HR Applications"
    },
    {
      "name": "HCM | Vertex Location City"
    },
    {
      "name": "HCM | HR Application History"
    },
    {
      "name": "HCM | HR Dependent Benefits"
    },
    {
      "name": "HCM | HR Dependent Deductions"
    },
    {
      "name": "HCM | HR Employee Elected Plans"
    },
    {
      "name": "HCM | HR Employee Training Certifications"
    },
    {
      "name": "HCM | HR Trainings"
    },
    {
      "name": "HCM | E-Timesheets"
    },
    {
      "name": "HCM | System Contacts"
    },
    {
      "name": "HCM | System User Payroll Security Group"
    },
    {
      "name": "HCM | Payroll Timesheet Posting"
    },
    {
      "name": "HCM | CrewTimesheet Posting"
    },
    {
      "name": "HCM | HR Positions Master"
    },
    {
      "name": "HCM | Payroll Pay Periods"
    },
    {
      "name": "HCM | Payroll Rate Codes"
    },
    {
      "name": "HCM | Payroll Overhead Codes and Rates"
    },
    {
      "name": "HCM | Payroll Assigned Overhead to Jobs"
    },
    {
      "name": "Materials  Management | Material Sale Orders"
    },
    {
      "name": "Materials  Management | Material Sale Orders Details"
    },
    {
      "name": "Materials  Management | Truck Rate Detail"
    },
    {
      "name": "Opportunity Management | Competitors"
    },
    {
      "name": "Opportunity Management | Opportunities"
    },
    {
      "name": "Opportunity Management | Revenue Details"
    },
    {
      "name": "Opportunity Management | Opportunity History"
    },
    {
      "name": "Opportunity Management | Organization"
    },
    {
      "name": "Project Controls | Job Billing"
    },
    {
      "name": "Project Controls | Job Cost"
    },
    {
      "name": "Project Controls | PCI Details"
    },
    {
      "name": "Project Controls | Unposted PCI Details"
    },
    {
      "name": "Project Controls | PCI Headers"
    },
    {
      "name": "Project Controls | Owner Change Orders"
    },
    {
      "name": "Project Controls | CM Statuses"
    },
    {
      "name": "Project Controls | CM Types"
    },
    {
      "name": "Project Controls | CM Vendor Details"
    },
    {
      "name": "Project Controls | Post PCI"
    },
    {
      "name": "Project Management | Uploading Documents"
    },
    {
      "name": "Project Management | Downloading Documents"
    },
    {
      "name": "Project Management | Foreign Bid Item Imports"
    },
    {
      "name": "Project Management | Communications"
    },
    {
      "name": "Project Management | Daily Journals"
    },
    {
      "name": "Project Management | Communications Types"
    },
    {
      "name": "Project Management | Daily Journal Daily Work Plans"
    },
    {
      "name": "Project Management | Daily Journal Field Forces"
    },
    {
      "name": "Project Management | Daily Journal Labour"
    },
    {
      "name": "Project Management | Daily Journal Materials"
    },
    {
      "name": "Project Management | Daily Journal Owner Equipment"
    },
    {
      "name": "Project Management | Daily Journal Quality Control"
    },
    {
      "name": "Project Management | Daily Journal Tasks"
    },
    {
      "name": "Project Management | Daily Journal Trade Equipment"
    },
    {
      "name": "Project Management | Daily Journal Transactions"
    },
    {
      "name": "Project Management | Daily Journal User Defined Data"
    },
    {
      "name": "Project Management | Daily Journal Visitors"
    },
    {
      "name": "Project Management | Daily Journal Bill Details"
    },
    {
      "name": "Project Management | Field Work Directives"
    },
    {
      "name": "Project Management | Contract Types"
    },
    {
      "name": "Project Management | Company Contacts"
    },
    {
      "name": "Project Management | Distribution BCC"
    },
    {
      "name": "Project Management | Distribution CC"
    },
    {
      "name": "Project Management | Field Work Directive Statuses"
    },
    {
      "name": "Project Management | Issues"
    },
    {
      "name": "Project Management | Key Players"
    },
    {
      "name": "Project Management | Meetings"
    },
    {
      "name": "Project Management | Meeting Attendees"
    },
    {
      "name": "Project Management | Meeting Item Statuses"
    },
    {
      "name": "Project Management | Meeting Tracks"
    },
    {
      "name": "Project Management | Notes"
    },
    {
      "name": "Project Management | Projects"
    },
    {
      "name": "Project Management | Project Items"
    },
    {
      "name": "Project Management | Project Item Phase Segment Sums"
    },
    {
      "name": "Project Management | Project Partners"
    },
    {
      "name": "Project Management | Notices"
    },
    {
      "name": "Project Management | Notice Statuses"
    },
    {
      "name": "Project Management | Owner JS Query"
    },
    {
      "name": "Project Management | PCI Real Locations"
    },
    {
      "name": "Project Management | Project Contacts"
    },
    {
      "name": "Project Management | RFIs (Requests for Information)"
    },
    {
      "name": "Project Management | RFI Statuses"
    },
    {
      "name": "Project Management | Submittal Packages"
    },
    {
      "name": "Project Management | Submittal Package Details"
    },
    {
      "name": "Project Management | Submittal Package Status"
    },
    {
      "name": "Project Management | Submittals"
    },
    {
      "name": "Project Management | Submittal Status"
    },
    {
      "name": "Project Management | Transmittals"
    },
    {
      "name": "Project Management | Subcontract Headers"
    },
    {
      "name": "Project Management | Subcontract Schedules"
    },
    {
      "name": "Project Management | Subcontract Sechedule Phase Segment Sums"
    },
    {
      "name": "Project Management | User Roles"
    },
    {
      "name": "Project Management | Punchlists"
    },
    {
      "name": "Project Management | Punchlist Details"
    },
    {
      "name": "Project Management | Punchlist Statuses"
    },
    {
      "name": "Project Management | Meeting Items"
    },
    {
      "name": "Project Management | Self Perform Vendor"
    },
    {
      "name": "Project Management | Submittal Types"
    },
    {
      "name": "Project Management | Assign contact and partner to project"
    },
    {
      "name": "Project Management | Subcontract Prequal"
    },
    {
      "name": "Project Management | Bid Item Package"
    }
  ],
  "paths": {
    "/hcm-rest-api/rest/1/pytaxemp": {
      "post": {
        "tags": [
          "HCM | Employee Tax Overrides"
        ],
        "summary": "Create a PY Tax Override",
        "description": "## Create Tax Overrrides\n\n###",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "TxpStateCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "State Code – Must be a valid state code from the PYSTATE (STA_STATE_CODE) table or ‘ALL’ for Federal tax."
                  },
                  "TxpCalcmeth": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "Calculation Method – This will be validated through Vertex."
                  },
                  "TxpLastUpdDate": {
                    "type": "string",
                    "description": "Date when the record was last updated."
                  },
                  "TxpEmpNo": {
                    "type": "string",
                    "maxLength": 16,
                    "description": "Employee Number – Must be a valid employee code from the PYEMPLOYEE_TABLE (EMP_NO) table."
                  },
                  "TxpUser": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "User who last updated this record."
                  },
                  "TxpWrlCode": {
                    "type": "string",
                    "maxLength": 15,
                    "description": "Work Location Code – Must be valid values from the PYWORKLOC (WRL_CODE) table."
                  },
                  "TxpEffectiveDate": {
                    "type": "string",
                    "description": "Effective Date (Starting date for the tax override)"
                  },
                  "TxpTaxCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "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."
                  },
                  "TxpVUuid": {
                    "type": "string",
                    "maxLength": 64,
                    "description": "Unique uuid of row"
                  },
                  "TxpAddSuplTaxRate": {
                    "type": "number",
                    "maxLength": 16,
                    "description": "Additional Supplementary Tax Rate – If entered, the payroll system will add this amount to the supplementary tax rate."
                  },
                  "TxpExcludeFlag": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "Exclude Tax Flag – If checked, this tax will be excluded from the employee. ‘Y’ or ‘N’"
                  },
                  "TxpAmtType": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "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"
                  },
                  "TxpTaxAmount": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Tax Override Amount."
                  },
                  "TxpJurintType": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "vertex jurinttreatment type"
                  },
                  "TxpOvrdSuplExempAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Override Supplementary Exemption Amount – If entered, the payroll system will use this as the supplementary exemption amount."
                  },
                  "TxpIuUpdateDate": {
                    "type": "string",
                    "description": "Time Stamp when record was updated last time,Leave Blank"
                  },
                  "TxpTaxType": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "Tax Type ‘R’ – Resident ‘W’ – Work ‘B’ – Both"
                  },
                  "TxpOvrdSuplTaxRate": {
                    "type": "number",
                    "maxLength": 16,
                    "description": "Override Supplementary Tax Rate – If entered the payroll system will use this tax rate instead of the supplementary Vertex rate."
                  },
                  "TxpIuCreateDate": {
                    "type": "string",
                    "description": "Time Stamp when record was created, Leave Blank"
                  },
                  "TxpExemptFlag": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "tax exempt flag (y/n/null)"
                  },
                  "TxpOvrdRglrTaxRate": {
                    "type": "number",
                    "maxLength": 16,
                    "description": "Override Regular Tax Rate – If entered, the payroll system will use this tax rate instead of the regular Vertex rate."
                  },
                  "TxpOvrdRglrExempAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Override Regular Exemption Amount – If entered, the payroll system will use this as the regular exemption amount."
                  },
                  "TxpAddPrimExempAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Number of Primary Exemptions"
                  },
                  "TxpAddSuplExempAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Number of Primary Exemptions"
                  },
                  "TxpMaxWage": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Maximum Wage Amount – The maximum wage amount that the tax will be calculated on."
                  },
                  "TxpIuCreateUser": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "User who created record,Leave Blank"
                  },
                  "TxpMaxDedOvrdAmt": {
                    "type": "number",
                    "maxLength": 18,
                    "description": "Maximum Override Deduction Amount – The maximum deduction amount that will be taken for this tax."
                  },
                  "TxpAltCalcCode": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "Alternate Calculation Code – This will be validated through Vertex."
                  },
                  "TxpAddRglrTaxRate": {
                    "type": "number",
                    "maxLength": 16,
                    "description": "Additional Regular Tax Rate – If entered, the payroll system will add this amount to the regular tax rate."
                  }
                },
                "required": [
                  "TxpStateCode",
                  "TxpCalcmeth",
                  "TxpLastUpdDate",
                  "TxpEmpNo",
                  "TxpUser",
                  "TxpWrlCode",
                  "TxpEffectiveDate",
                  "TxpTaxCode",
                  "TxpVUuid"
                ],
                "example": {
                  "TxpEmpNo": "801",
                  "TxpTaxCode": "FWT",
                  "TxpWrlCode": "ALL",
                  "TxpStateCode": "ALL",
                  "TxpCalcmeth": "02",
                  "TxpEffectiveDate": "2023-01-10",
                  "TxpLastUpdDate": "2023-01-11T02:36:53+00:00",
                  "TxpUser": "ARCORO",
                  "TxpVUuid": ""
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "application/vnd.oracle.adf.resourceItem+json"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/vnd.oracle.adf.resourceitem+json"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "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:53+00:00",
                  "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"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cmicBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication"
      }
    }
  }
}
````