POST api/NewHireImport
Imports a collection of NewHireImport records.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
newHireImports | A collection of NewHireImport records |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
[ { "EmployeeCode": "sample string 1", "CompanyCode": "sample string 2", "Division": "sample string 3", "BusinessUnit": "sample string 4", "Department": "sample string 5", "Location": "sample string 6", "FirstName": "sample string 7", "MiddleName": "sample string 8", "LastName": "sample string 9", "SocialSecurityNumber": "sample string 10", "BirthDate": "2022-07-03T04:38:20.0553145-05:00", "StreetAddress1": "sample string 12", "StreetAddress2": "sample string 13", "City": "sample string 14", "State": "sample string 15", "ZipCode": "sample string 16", "Country": "sample string 17", "County": "sample string 18", "AreaCode": "sample string 19", "PhoneNumber": "sample string 20", "Sex": "sample string 21", "SalaryAmount": 22.0, "HireDate": "2022-07-03T04:38:20.0553145-05:00", "TerminationDate": "2022-07-03T04:38:20.0553145-05:00", "JobCode": "sample string 24", "EmployeeStatusCode": "sample string 25", "EmployeePayType": "sample string 26", "NormalUnitAmount": 27.0, "UnitRate": 28.0, "PayrollSchedule": "sample string 29", "PayrollGroupCode": "sample string 30", "AutoTimesheetIndicator": true, "PayPeriodAmount": 32.0, "StateWitholding": "sample string 33", "StateUnemployment": "sample string 34", "EmployeeClassification": "sample string 35", "FederalMaritalStatus": "sample string 36", "StateMaritalStatus": "sample string 37", "PrimaryLocalMaritalStatus": "sample string 38", "SecondaryLocalMaritalStatus": "sample string 39", "FederalExemptions": 40, "StateExemptions": 41.0, "StateSpecialExemptions": 42.0, "PrimaryLocalExemptions": 43.0, "SecondaryLocalExemptions": 44.0, "FederalExtraAmount": 45.0, "StateExtraAmount": 46.0, "MaritalStatus": "sample string 47", "Position": "sample string 48", "CellPhoneAreaCode": "sample string 49", "CellPhoneNumber": "sample string 50", "PersonalEmailAddress": "sample string 51", "PrimaryContactMethod": "sample string 52", "PayrollScheduleId": 53, "MinimumWageCity": "sample string 54", "MinimumWageState": "sample string 55", "Race": "sample string 56", "EeoClass": "sample string 57", "Order": 58, "RoutingNumber": "sample string 59", "AccountNumber": "sample string 60", "AccountType": "sample string 61", "EffectiveDate": "2022-07-03T04:38:20.0553145-05:00", "Status": "sample string 62", "DepositAmount": "sample string 63", "PartialAmount": 64.0, "PartialAmountType": "sample string 65", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "sample string 66", "FederalW4_2020_Ind": true, "FederalMultipleJobs": "sample string 68", "FederalMultipleJobs_Ind": true, "FederalDependentTaxCredit_Amt": 70.0, "FederalOtherIncome_Amt": 71.0, "FederalDeductions_Amt": 72.0, "StateMultipleJobs": "sample string 73", "StateMultipleJobs_Ind": true, "StateDependentTaxCredit_Amt": 75.0, "StateOtherIncome_Amt": 76.0, "StateDeductions_Amt": 77.0 }, { "EmployeeCode": "sample string 1", "CompanyCode": "sample string 2", "Division": "sample string 3", "BusinessUnit": "sample string 4", "Department": "sample string 5", "Location": "sample string 6", "FirstName": "sample string 7", "MiddleName": "sample string 8", "LastName": "sample string 9", "SocialSecurityNumber": "sample string 10", "BirthDate": "2022-07-03T04:38:20.0553145-05:00", "StreetAddress1": "sample string 12", "StreetAddress2": "sample string 13", "City": "sample string 14", "State": "sample string 15", "ZipCode": "sample string 16", "Country": "sample string 17", "County": "sample string 18", "AreaCode": "sample string 19", "PhoneNumber": "sample string 20", "Sex": "sample string 21", "SalaryAmount": 22.0, "HireDate": "2022-07-03T04:38:20.0553145-05:00", "TerminationDate": "2022-07-03T04:38:20.0553145-05:00", "JobCode": "sample string 24", "EmployeeStatusCode": "sample string 25", "EmployeePayType": "sample string 26", "NormalUnitAmount": 27.0, "UnitRate": 28.0, "PayrollSchedule": "sample string 29", "PayrollGroupCode": "sample string 30", "AutoTimesheetIndicator": true, "PayPeriodAmount": 32.0, "StateWitholding": "sample string 33", "StateUnemployment": "sample string 34", "EmployeeClassification": "sample string 35", "FederalMaritalStatus": "sample string 36", "StateMaritalStatus": "sample string 37", "PrimaryLocalMaritalStatus": "sample string 38", "SecondaryLocalMaritalStatus": "sample string 39", "FederalExemptions": 40, "StateExemptions": 41.0, "StateSpecialExemptions": 42.0, "PrimaryLocalExemptions": 43.0, "SecondaryLocalExemptions": 44.0, "FederalExtraAmount": 45.0, "StateExtraAmount": 46.0, "MaritalStatus": "sample string 47", "Position": "sample string 48", "CellPhoneAreaCode": "sample string 49", "CellPhoneNumber": "sample string 50", "PersonalEmailAddress": "sample string 51", "PrimaryContactMethod": "sample string 52", "PayrollScheduleId": 53, "MinimumWageCity": "sample string 54", "MinimumWageState": "sample string 55", "Race": "sample string 56", "EeoClass": "sample string 57", "Order": 58, "RoutingNumber": "sample string 59", "AccountNumber": "sample string 60", "AccountType": "sample string 61", "EffectiveDate": "2022-07-03T04:38:20.0553145-05:00", "Status": "sample string 62", "DepositAmount": "sample string 63", "PartialAmount": 64.0, "PartialAmountType": "sample string 65", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "sample string 66", "FederalW4_2020_Ind": true, "FederalMultipleJobs": "sample string 68", "FederalMultipleJobs_Ind": true, "FederalDependentTaxCredit_Amt": 70.0, "FederalOtherIncome_Amt": 71.0, "FederalDeductions_Amt": 72.0, "StateMultipleJobs": "sample string 73", "StateMultipleJobs_Ind": true, "StateDependentTaxCredit_Amt": 75.0, "StateOtherIncome_Amt": 76.0, "StateDeductions_Amt": 77.0 }, { "EmployeeCode": "sample string 1", "CompanyCode": "sample string 2", "Division": "sample string 3", "BusinessUnit": "sample string 4", "Department": "sample string 5", "Location": "sample string 6", "FirstName": "sample string 7", "MiddleName": "sample string 8", "LastName": "sample string 9", "SocialSecurityNumber": "sample string 10", "BirthDate": "2022-07-03T04:38:20.0553145-05:00", "StreetAddress1": "sample string 12", "StreetAddress2": "sample string 13", "City": "sample string 14", "State": "sample string 15", "ZipCode": "sample string 16", "Country": "sample string 17", "County": "sample string 18", "AreaCode": "sample string 19", "PhoneNumber": "sample string 20", "Sex": "sample string 21", "SalaryAmount": 22.0, "HireDate": "2022-07-03T04:38:20.0553145-05:00", "TerminationDate": "2022-07-03T04:38:20.0553145-05:00", "JobCode": "sample string 24", "EmployeeStatusCode": "sample string 25", "EmployeePayType": "sample string 26", "NormalUnitAmount": 27.0, "UnitRate": 28.0, "PayrollSchedule": "sample string 29", "PayrollGroupCode": "sample string 30", "AutoTimesheetIndicator": true, "PayPeriodAmount": 32.0, "StateWitholding": "sample string 33", "StateUnemployment": "sample string 34", "EmployeeClassification": "sample string 35", "FederalMaritalStatus": "sample string 36", "StateMaritalStatus": "sample string 37", "PrimaryLocalMaritalStatus": "sample string 38", "SecondaryLocalMaritalStatus": "sample string 39", "FederalExemptions": 40, "StateExemptions": 41.0, "StateSpecialExemptions": 42.0, "PrimaryLocalExemptions": 43.0, "SecondaryLocalExemptions": 44.0, "FederalExtraAmount": 45.0, "StateExtraAmount": 46.0, "MaritalStatus": "sample string 47", "Position": "sample string 48", "CellPhoneAreaCode": "sample string 49", "CellPhoneNumber": "sample string 50", "PersonalEmailAddress": "sample string 51", "PrimaryContactMethod": "sample string 52", "PayrollScheduleId": 53, "MinimumWageCity": "sample string 54", "MinimumWageState": "sample string 55", "Race": "sample string 56", "EeoClass": "sample string 57", "Order": 58, "RoutingNumber": "sample string 59", "AccountNumber": "sample string 60", "AccountType": "sample string 61", "EffectiveDate": "2022-07-03T04:38:20.0553145-05:00", "Status": "sample string 62", "DepositAmount": "sample string 63", "PartialAmount": 64.0, "PartialAmountType": "sample string 65", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "sample string 66", "FederalW4_2020_Ind": true, "FederalMultipleJobs": "sample string 68", "FederalMultipleJobs_Ind": true, "FederalDependentTaxCredit_Amt": 70.0, "FederalOtherIncome_Amt": 71.0, "FederalDeductions_Amt": 72.0, "StateMultipleJobs": "sample string 73", "StateMultipleJobs_Ind": true, "StateDependentTaxCredit_Amt": 75.0, "StateOtherIncome_Amt": 76.0, "StateDeductions_Amt": 77.0 } ]
application/xml, text/xml
Sample:
<ArrayOfNewHireImportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.API.External.Areas.Employees.Models"> <NewHireImportDto> <AccountNumber>sample string 60</AccountNumber> <AccountType>sample string 61</AccountType> <AreaCode>sample string 19</AreaCode> <AutoTimesheetIndicator>true</AutoTimesheetIndicator> <BirthDate>2022-07-03T04:38:20.0553145-05:00</BirthDate> <BusinessUnit>sample string 4</BusinessUnit> <CellPhoneAreaCode>sample string 49</CellPhoneAreaCode> <CellPhoneNumber>sample string 50</CellPhoneNumber> <City>sample string 14</City> <CompanyCode>sample string 2</CompanyCode> <Country>sample string 17</Country> <County>sample string 18</County> <Department>sample string 5</Department> <DepositAmount>sample string 63</DepositAmount> <Division>sample string 3</Division> <EeoClass>sample string 57</EeoClass> <EffectiveDate>2022-07-03T04:38:20.0553145-05:00</EffectiveDate> <EmployeeClassification>sample string 35</EmployeeClassification> <EmployeeCode>sample string 1</EmployeeCode> <EmployeePayType>sample string 26</EmployeePayType> <EmployeeStatusCode>sample string 25</EmployeeStatusCode> <FederalDeductions_Amt>72</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>70</FederalDependentTaxCredit_Amt> <FederalExemptions>40</FederalExemptions> <FederalExtraAmount>45</FederalExtraAmount> <FederalMaritalStatus>sample string 36</FederalMaritalStatus> <FederalMultipleJobs>sample string 68</FederalMultipleJobs> <FederalMultipleJobs_Ind>true</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>71</FederalOtherIncome_Amt> <FederalW4_2020_Ind>true</FederalW4_2020_Ind> <FirstName>sample string 7</FirstName> <HireDate>2022-07-03T04:38:20.0553145-05:00</HireDate> <JobCode>sample string 24</JobCode> <LastName>sample string 9</LastName> <Location>sample string 6</Location> <MaritalStatus>sample string 47</MaritalStatus> <MiddleName>sample string 8</MiddleName> <MinimumWageCity>sample string 54</MinimumWageCity> <MinimumWageState>sample string 55</MinimumWageState> <NormalUnitAmount>27</NormalUnitAmount> <Order>58</Order> <PartialAmount>64</PartialAmount> <PartialAmountType>sample string 65</PartialAmountType> <PayPeriodAmount>32</PayPeriodAmount> <PayrollGroupCode>sample string 30</PayrollGroupCode> <PayrollSchedule>sample string 29</PayrollSchedule> <PayrollScheduleId>53</PayrollScheduleId> <PersonalEmailAddress>sample string 51</PersonalEmailAddress> <PhoneNumber>sample string 20</PhoneNumber> <Position>sample string 48</Position> <PrimaryContactMethod>sample string 52</PrimaryContactMethod> <PrimaryLocalExemptions>43</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus>sample string 38</PrimaryLocalMaritalStatus> <Race>sample string 56</Race> <RoutingNumber>sample string 59</RoutingNumber> <SalaryAmount>22</SalaryAmount> <SecondaryLocalExemptions>44</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus>sample string 39</SecondaryLocalMaritalStatus> <Sex>sample string 21</Sex> <SocialSecurityNumber>sample string 10</SocialSecurityNumber> <State>sample string 15</State> <StateDeductions_Amt>77</StateDeductions_Amt> <StateDependentTaxCredit_Amt>75</StateDependentTaxCredit_Amt> <StateExemptions>41</StateExemptions> <StateExtraAmount>46</StateExtraAmount> <StateMaritalStatus>sample string 37</StateMaritalStatus> <StateMultipleJobs>sample string 73</StateMultipleJobs> <StateMultipleJobs_Ind>true</StateMultipleJobs_Ind> <StateOtherIncome_Amt>76</StateOtherIncome_Amt> <StateSpecialExemptions>42</StateSpecialExemptions> <StateUnemployment>sample string 34</StateUnemployment> <StateWitholding>sample string 33</StateWitholding> <Status>sample string 62</Status> <StreetAddress1>sample string 12</StreetAddress1> <StreetAddress2>sample string 13</StreetAddress2> <TerminationDate>2022-07-03T04:38:20.0553145-05:00</TerminationDate> <UnitRate>28</UnitRate> <W4Form2020>sample string 66</W4Form2020> <ZipCode>sample string 16</ZipCode> </NewHireImportDto> <NewHireImportDto> <AccountNumber>sample string 60</AccountNumber> <AccountType>sample string 61</AccountType> <AreaCode>sample string 19</AreaCode> <AutoTimesheetIndicator>true</AutoTimesheetIndicator> <BirthDate>2022-07-03T04:38:20.0553145-05:00</BirthDate> <BusinessUnit>sample string 4</BusinessUnit> <CellPhoneAreaCode>sample string 49</CellPhoneAreaCode> <CellPhoneNumber>sample string 50</CellPhoneNumber> <City>sample string 14</City> <CompanyCode>sample string 2</CompanyCode> <Country>sample string 17</Country> <County>sample string 18</County> <Department>sample string 5</Department> <DepositAmount>sample string 63</DepositAmount> <Division>sample string 3</Division> <EeoClass>sample string 57</EeoClass> <EffectiveDate>2022-07-03T04:38:20.0553145-05:00</EffectiveDate> <EmployeeClassification>sample string 35</EmployeeClassification> <EmployeeCode>sample string 1</EmployeeCode> <EmployeePayType>sample string 26</EmployeePayType> <EmployeeStatusCode>sample string 25</EmployeeStatusCode> <FederalDeductions_Amt>72</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>70</FederalDependentTaxCredit_Amt> <FederalExemptions>40</FederalExemptions> <FederalExtraAmount>45</FederalExtraAmount> <FederalMaritalStatus>sample string 36</FederalMaritalStatus> <FederalMultipleJobs>sample string 68</FederalMultipleJobs> <FederalMultipleJobs_Ind>true</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>71</FederalOtherIncome_Amt> <FederalW4_2020_Ind>true</FederalW4_2020_Ind> <FirstName>sample string 7</FirstName> <HireDate>2022-07-03T04:38:20.0553145-05:00</HireDate> <JobCode>sample string 24</JobCode> <LastName>sample string 9</LastName> <Location>sample string 6</Location> <MaritalStatus>sample string 47</MaritalStatus> <MiddleName>sample string 8</MiddleName> <MinimumWageCity>sample string 54</MinimumWageCity> <MinimumWageState>sample string 55</MinimumWageState> <NormalUnitAmount>27</NormalUnitAmount> <Order>58</Order> <PartialAmount>64</PartialAmount> <PartialAmountType>sample string 65</PartialAmountType> <PayPeriodAmount>32</PayPeriodAmount> <PayrollGroupCode>sample string 30</PayrollGroupCode> <PayrollSchedule>sample string 29</PayrollSchedule> <PayrollScheduleId>53</PayrollScheduleId> <PersonalEmailAddress>sample string 51</PersonalEmailAddress> <PhoneNumber>sample string 20</PhoneNumber> <Position>sample string 48</Position> <PrimaryContactMethod>sample string 52</PrimaryContactMethod> <PrimaryLocalExemptions>43</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus>sample string 38</PrimaryLocalMaritalStatus> <Race>sample string 56</Race> <RoutingNumber>sample string 59</RoutingNumber> <SalaryAmount>22</SalaryAmount> <SecondaryLocalExemptions>44</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus>sample string 39</SecondaryLocalMaritalStatus> <Sex>sample string 21</Sex> <SocialSecurityNumber>sample string 10</SocialSecurityNumber> <State>sample string 15</State> <StateDeductions_Amt>77</StateDeductions_Amt> <StateDependentTaxCredit_Amt>75</StateDependentTaxCredit_Amt> <StateExemptions>41</StateExemptions> <StateExtraAmount>46</StateExtraAmount> <StateMaritalStatus>sample string 37</StateMaritalStatus> <StateMultipleJobs>sample string 73</StateMultipleJobs> <StateMultipleJobs_Ind>true</StateMultipleJobs_Ind> <StateOtherIncome_Amt>76</StateOtherIncome_Amt> <StateSpecialExemptions>42</StateSpecialExemptions> <StateUnemployment>sample string 34</StateUnemployment> <StateWitholding>sample string 33</StateWitholding> <Status>sample string 62</Status> <StreetAddress1>sample string 12</StreetAddress1> <StreetAddress2>sample string 13</StreetAddress2> <TerminationDate>2022-07-03T04:38:20.0553145-05:00</TerminationDate> <UnitRate>28</UnitRate> <W4Form2020>sample string 66</W4Form2020> <ZipCode>sample string 16</ZipCode> </NewHireImportDto> <NewHireImportDto> <AccountNumber>sample string 60</AccountNumber> <AccountType>sample string 61</AccountType> <AreaCode>sample string 19</AreaCode> <AutoTimesheetIndicator>true</AutoTimesheetIndicator> <BirthDate>2022-07-03T04:38:20.0553145-05:00</BirthDate> <BusinessUnit>sample string 4</BusinessUnit> <CellPhoneAreaCode>sample string 49</CellPhoneAreaCode> <CellPhoneNumber>sample string 50</CellPhoneNumber> <City>sample string 14</City> <CompanyCode>sample string 2</CompanyCode> <Country>sample string 17</Country> <County>sample string 18</County> <Department>sample string 5</Department> <DepositAmount>sample string 63</DepositAmount> <Division>sample string 3</Division> <EeoClass>sample string 57</EeoClass> <EffectiveDate>2022-07-03T04:38:20.0553145-05:00</EffectiveDate> <EmployeeClassification>sample string 35</EmployeeClassification> <EmployeeCode>sample string 1</EmployeeCode> <EmployeePayType>sample string 26</EmployeePayType> <EmployeeStatusCode>sample string 25</EmployeeStatusCode> <FederalDeductions_Amt>72</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>70</FederalDependentTaxCredit_Amt> <FederalExemptions>40</FederalExemptions> <FederalExtraAmount>45</FederalExtraAmount> <FederalMaritalStatus>sample string 36</FederalMaritalStatus> <FederalMultipleJobs>sample string 68</FederalMultipleJobs> <FederalMultipleJobs_Ind>true</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>71</FederalOtherIncome_Amt> <FederalW4_2020_Ind>true</FederalW4_2020_Ind> <FirstName>sample string 7</FirstName> <HireDate>2022-07-03T04:38:20.0553145-05:00</HireDate> <JobCode>sample string 24</JobCode> <LastName>sample string 9</LastName> <Location>sample string 6</Location> <MaritalStatus>sample string 47</MaritalStatus> <MiddleName>sample string 8</MiddleName> <MinimumWageCity>sample string 54</MinimumWageCity> <MinimumWageState>sample string 55</MinimumWageState> <NormalUnitAmount>27</NormalUnitAmount> <Order>58</Order> <PartialAmount>64</PartialAmount> <PartialAmountType>sample string 65</PartialAmountType> <PayPeriodAmount>32</PayPeriodAmount> <PayrollGroupCode>sample string 30</PayrollGroupCode> <PayrollSchedule>sample string 29</PayrollSchedule> <PayrollScheduleId>53</PayrollScheduleId> <PersonalEmailAddress>sample string 51</PersonalEmailAddress> <PhoneNumber>sample string 20</PhoneNumber> <Position>sample string 48</Position> <PrimaryContactMethod>sample string 52</PrimaryContactMethod> <PrimaryLocalExemptions>43</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus>sample string 38</PrimaryLocalMaritalStatus> <Race>sample string 56</Race> <RoutingNumber>sample string 59</RoutingNumber> <SalaryAmount>22</SalaryAmount> <SecondaryLocalExemptions>44</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus>sample string 39</SecondaryLocalMaritalStatus> <Sex>sample string 21</Sex> <SocialSecurityNumber>sample string 10</SocialSecurityNumber> <State>sample string 15</State> <StateDeductions_Amt>77</StateDeductions_Amt> <StateDependentTaxCredit_Amt>75</StateDependentTaxCredit_Amt> <StateExemptions>41</StateExemptions> <StateExtraAmount>46</StateExtraAmount> <StateMaritalStatus>sample string 37</StateMaritalStatus> <StateMultipleJobs>sample string 73</StateMultipleJobs> <StateMultipleJobs_Ind>true</StateMultipleJobs_Ind> <StateOtherIncome_Amt>76</StateOtherIncome_Amt> <StateSpecialExemptions>42</StateSpecialExemptions> <StateUnemployment>sample string 34</StateUnemployment> <StateWitholding>sample string 33</StateWitholding> <Status>sample string 62</Status> <StreetAddress1>sample string 12</StreetAddress1> <StreetAddress2>sample string 13</StreetAddress2> <TerminationDate>2022-07-03T04:38:20.0553145-05:00</TerminationDate> <UnitRate>28</UnitRate> <W4Form2020>sample string 66</W4Form2020> <ZipCode>sample string 16</ZipCode> </NewHireImportDto> </ArrayOfNewHireImportDto>
Response Information
Returns success indications and messages on import operation for each record. conditionally indicates whether the New Hire Import list is empty.
Response body formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.