Load Employees

You will be able to update employee data or an employee position in the LoadEmployee API. You can either update a single or multiple employee position. If multiple positions are specified in the data load, you will have to provide new values for the Employee Number, Employee Name, and Employee Position Description fields. All the updated values will be reflected in an Audit log file. In addition, you will now be able to process employee data using the process option.

Notes:

• Existing compensations are overwritten with any compensations mapped against the employee type code. Allocations are also overridden.

• If duplicate positions exist, we do not load/update such positions.

Method: POST

Endpoint Url Syntax: /HostApi/HostAPI_StateFree.asmx

Content Type: text/xml

Header

Request (XML)

This below request contains multiple employee positions for a single employee

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.******.com/API/SOAP/StateFree/Common/2009/03/19">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:LoadEmployees>
         <!--Optional:-->
        <ns:LoginName>*******@gmail.com</ns:LoginName>
         <!--Optional:-->
         <ns:Password>**********</ns:Password>
         <!--Optional:-->
         <ns:TenantCode>Tenantname</ns:TenantCode>
         <!--Optional:-->
         <ns:employees1>
            <!--Zero or more repetitions:-->
            <ns:EmployeePosition>
               <!--Optional:-->
               <ns:EmployeeInfo>
                  <!--Optional:-->
                  <ns:ScenarioCode>Budg 2023.ChC</ns:ScenarioCode>
                  <!--Optional:-->
                  <ns:HomeBudgetEntityCode>BUDG2023ChEH</ns:HomeBudgetEntityCode>
                 <ns:Number>HAIND-BUDG_006</ns:Number>
			  <ns:Name>Employee6</ns:Name>
 			  <ns:HireDate>2010-01-01T00:00:00</ns:HireDate>
               </ns:EmployeeInfo>
               <ns:PositionName>DEV</ns:PositionName>               
               <!--Optional:-->
               <ns:PositionEntityCode>BUDG2023ChEH</ns:PositionEntityCode>
               <!--Optional:-->
               <ns:OtherSegmentCodes>
                  <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>ICSegment</ns:Key>
                     <!--Optional:-->
                     <ns:Value>1015</ns:Value>
                  </ns:KeyValues>
                   <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>Geography</ns:Key>
                     <!--Optional:-->
                     <ns:Value>110-1150</ns:Value>
                  </ns:KeyValues>
               </ns:OtherSegmentCodes>
               <!--Optional:-->
               <ns:EmployeeTypeCode>PT</ns:EmployeeTypeCode>
               <ns:PayPlanCode>Equal Monthly</ns:PayPlanCode>
               <ns:WageType>H</ns:WageType>
               <ns:Salary>12000</ns:Salary>
               <ns:FromDate>2017-01-01T00:00:00</ns:FromDate>
               <ns:reviewType>Single</ns:reviewType>
               <ns:NextReviewDate>2017-01-01T00:00:00</ns:NextReviewDate>
               <!--Optional:-->
               <ns:Attribute>
                  <!--Zero or more repetitions:-->
                  <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>Work State</ns:Key>
                     <!--Optional:-->
                     <ns:Value>AK</ns:Value>
                  </ns:KeyValues>
                 </ns:Attribute>
               <!--Optional:-->            
               <ns:BudgetReviewPercentage>1</ns:BudgetReviewPercentage>
               <ns:CurrentReviewPercentage>2</ns:CurrentReviewPercentage>
               <!--Optional:-->
               <!--Optional:-->
               <ns:notes>Test123</ns:notes>
            </ns:EmployeePosition>
                <ns:EmployeePosition>
               <!--Optional:-->
               <ns:EmployeeInfo>
                  <!--Optional:-->
                  <ns:ScenarioCode>Budg 2023.ChC</ns:ScenarioCode>
                  <!--Optional:-->
                  <ns:HomeBudgetEntityCode>BUDG2023ChEH</ns:HomeBudgetEntityCode>
                 <ns:Number>HAIND-BUDG_006</ns:Number>
			  <ns:Name>Employee6</ns:Name>
 			  <ns:HireDate>2010-01-01T00:00:00</ns:HireDate>
               </ns:EmployeeInfo>
               <ns:PositionName>QA</ns:PositionName>                             
               <!--Optional:-->
               <ns:PositionEntityCode>BUDG2023ChEH</ns:PositionEntityCode>
               <!--Optional:-->
               <ns:OtherSegmentCodes>
                  <!--Zero or more repetitions:-->
                  <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>ICSegment</ns:Key>
                     <!--Optional:-->
                     <ns:Value>1015</ns:Value>
                  </ns:KeyValues>
                   <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>Geography</ns:Key>
                     <!--Optional:-->
                     <ns:Value>110-1150</ns:Value>
                  </ns:KeyValues>
               </ns:OtherSegmentCodes>
               <!--Optional:-->
               <ns:EmployeeTypeCode>PT</ns:EmployeeTypeCode>
               <!--Optional:-->
               <ns:PayPlanCode>Equal Monthly</ns:PayPlanCode>
               <!--Optional:-->
               <ns:WageType>H</ns:WageType>
               <ns:Salary>12000</ns:Salary>
               <ns:FromDate>2017-01-01T00:00:00</ns:FromDate>
               <!--Optional:-->
               <ns:reviewType>Single</ns:reviewType>
               <ns:NextReviewDate>2017-01-01T00:00:00</ns:NextReviewDate>
               <!--Optional:-->
               <ns:Attribute>
                  <!--Zero or more repetitions:-->
                  <ns:KeyValues>
                     <!--Optional:-->
                     <ns:Key>Work State</ns:Key>
                     <!--Optional:-->
                     <ns:Value>AK</ns:Value>
                  </ns:KeyValues>
                 </ns:Attribute>
               <!--Optional:-->            
               <ns:BudgetReviewPercentage>1</ns:BudgetReviewPercentage>
               <ns:CurrentReviewPercentage>2</ns:CurrentReviewPercentage>
               <!--Optional:-->
               <!--Optional:-->
               <ns:notes>Test123</ns:notes>
            </ns:EmployeePosition>
         </ns:employees1>
         <ns:payRollUploadDate>2010-01-01T00:00:00</ns:payRollUploadDate>
         <!--Optional:-->
         <ns:AutoProcess>True</ns:AutoProcess>
      </ns:LoadEmployees>
   </soapenv:Body>
</soapenv:Envelope>

Response (XML)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <LoadEmployeesResponse xmlns="http://www.******.com/API/SOAP/StateFree/Common/2009/03/19">
         <LoadEmployeesResult>
            <EmployeeStatuses>
               <EmployeeStatus>
                  <EmployeeInfo>
                     <ScenarioCode>Budg 2023.ChC</ScenarioCode>
                     <HomeBudgetEntityCode>BUDG2023ChEH</HomeBudgetEntityCode>
                     <Number>HAIND-BUDG_006</Number>
                     <Name>Employee6</Name>
                     <HireDate>2010-01-01T00:00:00</HireDate>
                  </EmployeeInfo>
                  <Status>true</Status>
                  <ErrorMessage>Employee added successfully.</ErrorMessage>
                  <PositionName>DEV</PositionName>
               </EmployeeStatus>
               <EmployeeStatus>
                  <EmployeeInfo>
                     <ScenarioCode>Budg 2023.ChC</ScenarioCode>
                     <HomeBudgetEntityCode>BUDG2023ChEH</HomeBudgetEntityCode>
                     <Number>HAIND-BUDG_006</Number>
                     <Name>Employee6</Name>
                     <HireDate>2010-01-01T00:00:00</HireDate>
                  </EmployeeInfo>
                  <Status>true</Status>
                  <ErrorMessage>Employee added successfully.</ErrorMessage>
                  <PositionName>QA</PositionName>
               </EmployeeStatus>
            </EmployeeStatuses>
            <TotalEmployeesLoaded>2</TotalEmployeesLoaded>
            <EmployeeLoadSuccessCount>2</EmployeeLoadSuccessCount>
            <EmployeeLoadFailureCount>0</EmployeeLoadFailureCount>
         </LoadEmployeesResult>
      </LoadEmployeesResponse>
   </soap:Body>
</soap:Envelope>