> ## 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 Employee Pay Split

> ## Create Employee Pay Splits

UI Location: Human Capital Management - US Payroll - Setup - Employees - Direct Deposit and Check Accounts

###

## OpenAPI

````json POST /hcm-rest-api/rest/1/pyempsalspl
{
  "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/pyempsalspl": {
      "post": {
        "tags": [
          "HCM | Employee Pay Splits"
        ],
        "summary": "Create a PY Employee Pay Split",
        "description": "## Create Employee Pay Splits\n\nUI Location: Human Capital Management - US Payroll - Setup - Employees - Direct Deposit and Check Accounts\n\n###",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "EssBankCode": {
                    "type": "string",
                    "maxLength": 9,
                    "description": "Bank Code - If Direct Deposit, this must be a valid bank code already set up in CMiC.\n\n💻 UI Fieldname: Bank"
                  },
                  "EssCompCode": {
                    "type": "string",
                    "maxLength": 8,
                    "description": "Company Code"
                  },
                  "EssVUuid": {
                    "type": "string",
                    "maxLength": 64,
                    "description": "Unique uuid of row"
                  },
                  "EssUser": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "Userwho last updated this record."
                  },
                  "EssSplitNumber": {
                    "type": "number",
                    "maxLength": 3,
                    "description": "Priority - Prioritize each detail line by employee. (Use 1,2,3, etc.). Each Company/Employee/Priority number combination must be unique. The amounts will be calculated in priority sequence.\n\n💻 UI Fieldname: \\* Priority"
                  },
                  "EssLastUpdDate": {
                    "type": "string",
                    "description": "Date when the record was last updated."
                  },
                  "EssEmpNo": {
                    "type": "string",
                    "maxLength": 16,
                    "description": "Employee Code - Must be valid employee already set up in CMiC."
                  },
                  "EssTranCode": {
                    "type": "string",
                    "maxLength": 4,
                    "description": "Transaction Code Corresponding To The Transaction Type. Can Either Be A Benefit, Leave Or Expense Code. ALL is a valid option. ALL means all benefit, leave and expense codes. Can Only Be Populated If ess_split_method IS NULL And The ess_tran_type IS NOT NULL\n\n💻 UI Fieldname: Tran Code"
                  },
                  "EssRowid": {
                    "type": "string",
                    "description": ""
                  },
                  "EssBankAccNumber": {
                    "type": "string",
                    "maxLength": 34,
                    "description": "Bank Account Number - If Direct Deposit, this is the employee's actual bank account number."
                  },
                  "EssSplitType": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "Split Type 'D' - Direct Deposit 'C' - Check\n\n💻 UI Fieldname: \\* Split Type"
                  },
                  "EssAchTranCode": {
                    "type": "string",
                    "maxLength": 2,
                    "description": "ACH Transaction Code - If Direct Deposit, this must be a valid “Normal†ACH Tran Code already set up in CMiC."
                  },
                  "EssEmpSalSplitType": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "Methodof Salary Deposit - This determines how you will be splitting pay amounts if you choose to do so. 'P' - Percentage split 'F' - Flat Amount split"
                  },
                  "EssSplitPercent": {
                    "type": "number",
                    "maxLength": 10,
                    "description": "Percentage/Flat Amount - If the Method of Salary Deposit (ESS_EMP_SAL_SPLIT_TYPE) is 'P' for Percentage then you must enter the split percentage into this field. If using percentages, the percentages must add up to 100%. If the split type is 'F' for Flat Amount, then you must enter the amount into this field. If Split Method (ESS_SPLIT_METHOD) is 'A' for Advanced, leave this field null.\n\n💻 UI Fieldname: Percent/ Flat Amount"
                  },
                  "EssTranType": {
                    "type": "string",
                    "maxLength": 3,
                    "description": "Transaction Type. Can Only Be Either Of The Following: BN - Benefit, LE - Leaves Or EX - Expense. ALL is a valid option. ALL means all benefits, leaves and expenses. Can Only Be Populated If ess_split_method IS NULL.\n\n💻 UI Fieldname: Tran Type"
                  },
                  "DiscriminatorCode": {
                    "type": "string",
                    "description": ""
                  },
                  "EssSplitMethod": {
                    "type": "string",
                    "maxLength": 1,
                    "description": "Split Method. Valid Values Are (A)dvanced and (B)asic. Advanced Means ess_tran_type And ess_tran_code Must Be Filled In. Basic Means ess_tran_type and ess_tran_code Are Not Available.\n\n💻 UI Fieldname: \\* Split Method"
                  },
                  "EssNormTranCode": {
                    "type": "string",
                    "maxLength": 1,
                    "description": ""
                  },
                  "EssTenantId": {
                    "type": "string",
                    "maxLength": 30,
                    "description": "Tenant ID, Leave Blank"
                  },
                  "EssBranchCode": {
                    "type": "string",
                    "maxLength": 5,
                    "description": "Bank Branch Code - If Direct Deposit, this must be a valid bank branch code already set up in CMiC.\n\n💻 UI Fieldname: Branch"
                  },
                  "EssPrenoteCnt": {
                    "type": "number",
                    "description": "Pre-Note Count - Enter a zero '0' for this field."
                  }
                },
                "required": [
                  "EssBankCode",
                  "EssCompCode",
                  "EssVUuid",
                  "EssUser",
                  "EssSplitNumber",
                  "EssLastUpdDate",
                  "EssEmpNo"
                ],
                "example": {
                  "EssCompCode": "001",
                  "EssEmpNo": "1010",
                  "EssBankCode": "BOA",
                  "EssSplitNumber": "4",
                  "EssLastUpdDate": "2022-05-20T14:23:45+00:00",
                  "EssUser": "ADWAIT",
                  "EssVUuid": ""
                }
              }
            }
          }
        },
        "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": {
                  "EssCompCode": "001",
                  "EssEmpNo": "1010",
                  "EssSplitNumber": 4,
                  "EssSplitType": null,
                  "EssBankAccNumber": null,
                  "EssBankCode": "BOA",
                  "EssBranchCode": null,
                  "EssSplitPercent": null,
                  "EssUser": "ADWAIT",
                  "EssLastUpdDate": "2022-05-20T14:23:45+00:00",
                  "EssAchTranCode": null,
                  "EssPrenoteCnt": null,
                  "EssEmpSalSplitType": null,
                  "EssSplitMethod": null,
                  "EssTranType": null,
                  "EssTranCode": null,
                  "EssNormTranCode": null,
                  "EssVUuid": "F2A4A14B8AAC7A24E05316821FACC292",
                  "links": [
                    {
                      "rel": "self",
                      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsalspl/F2A4A14B8AAC7A24E05316821FACC292",
                      "name": "pyempsalspl",
                      "kind": "item"
                    },
                    {
                      "rel": "canonical",
                      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyempsalspl/F2A4A14B8AAC7A24E05316821FACC292",
                      "name": "pyempsalspl",
                      "kind": "item"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cmicBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication"
      }
    }
  }
}
````