Create a PY Tax Override
    • 27 Feb 2025
    • 3 Minutes to read
    • Dark
      Light

    Create a PY Tax Override

    • Dark
      Light

    Article summary

    Post
    /hcm-rest-api/rest/1/pytaxemp

    Create Tax Overrrides

    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    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": "" }
    TxpStateCode
    string Required

    State Code – Must be a valid state code from the PYSTATE (STA_STATE_CODE) table or ‘ALL’ for Federal tax.

    Max length4
    TxpCalcmeth
    string Required

    Calculation Method – This will be validated through Vertex.

    Max length2
    TxpLastUpdDate
    string Required

    Date when the record was last updated.

    TxpEmpNo
    string Required

    Employee Number – Must be a valid employee code from the PYEMPLOYEE_TABLE (EMP_NO) table.

    Max length16
    TxpUser
    string Required

    User who last updated this record.

    Max length30
    TxpWrlCode
    string Required

    Work Location Code – Must be valid values from the PYWORKLOC (WRL_CODE) table.

    Max length15
    TxpEffectiveDate
    string Required

    Effective Date (Starting date for the tax override)

    TxpTaxCode
    string 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
    TxpVUuid
    string Required

    Unique uuid of row

    Max length64
    TxpAddSuplTaxRate
    number

    Additional Supplementary Tax Rate – If entered, the payroll system will add this amount to the supplementary tax rate.

    Max length16
    TxpExcludeFlag
    string

    Exclude Tax Flag – If checked, this tax will be excluded from the employee. ‘Y’ or ‘N’

    Max length1
    TxpAmtType
    string

    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
    TxpTaxAmount
    number

    Tax Override Amount.

    Max length18
    TxpJurintType
    string

    vertex jurinttreatment type

    Max length2
    TxpOvrdSuplExempAmt
    number

    Override Supplementary Exemption Amount – If entered, the payroll system will use this as the supplementary exemption amount.

    Max length18
    TxpIuUpdateDate
    string

    Time Stamp when record was updated last time,Leave Blank

    TxpTaxType
    string

    Tax Type ‘R’ – Resident ‘W’ – Work ‘B’ – Both

    Max length1
    TxpOvrdSuplTaxRate
    number

    Override Supplementary Tax Rate – If entered the payroll system will use this tax rate instead of the supplementary Vertex rate.

    Max length16
    TxpIuCreateDate
    string

    Time Stamp when record was created, Leave Blank

    TxpExemptFlag
    string

    tax exempt flag (y/n/null)

    Max length1
    TxpOvrdRglrTaxRate
    number

    Override Regular Tax Rate – If entered, the payroll system will use this tax rate instead of the regular Vertex rate.

    Max length16
    TxpOvrdRglrExempAmt
    number

    Override Regular Exemption Amount – If entered, the payroll system will use this as the regular exemption amount.

    Max length18
    TxpAddPrimExempAmt
    number

    Number of Primary Exemptions

    Max length18
    TxpAddSuplExempAmt
    number

    Number of Primary Exemptions

    Max length18
    TxpMaxWage
    number

    Maximum Wage Amount – The maximum wage amount that the tax will be calculated on.

    Max length18
    TxpIuCreateUser
    string

    User who created record,Leave Blank

    Max length30
    TxpMaxDedOvrdAmt
    number

    Maximum Override Deduction Amount – The maximum deduction amount that will be taken for this tax.

    Max length18
    TxpAltCalcCode
    string

    Alternate Calculation Code – This will be validated through Vertex.

    Max length2
    TxpAddRglrTaxRate
    number

    Additional Regular Tax Rate – If entered, the payroll system will add this amount to the regular tax rate.

    Max length16
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+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