POST api/NewHireImport
[Soon to be obsolete] Imports a collection of NewHireImport records.
Request Information
Parameters
Name | Description |
---|---|
newHireImports
(param in the body) |
A collection of NewHireImport records. Each NewHireImport item must abide by these rules for the listed properties. -------------------------------------- EmployeeSelfServiceUserAccess (string) • Must be exactly "full" or "none" • If not provided, "none" will be used • If other values provided, it will not pass validation • "Full" access requires existence of personal email, otherwise validation fails • New Account Email is only sent to employees with "full" access • New Account Sms is only sent to employees with "full" access, a valid Cell Phone and Company Claim enabled CompanyCode (string) • Not null • 0 <= length <= 3 Division (string) • Not null • 0 <= length <= 3 BusinessUnit (string) • Not null • 0 <= length <= 5 Department (string) • Not null • 0 <= length <= 5 FirstName (string) • Not null • 0 <= length <= 30 • Follows regex pattern "^[a-zA-Z]+$" MiddleName (string) • 0 <= length <= 20 • Follows regex pattern "^[a-zA-Z]*$" LastName (string) • Not null • 0 <= length <= 30 • Follows regex pattern "^[a-zA-Z]+$" SocialSecurityNumber (string) • Not null • 0 <= length <= 11 • (Follows regex pattern "^([0-8]{1})([0-9]{2})(-{1})([0-9]{2})(-{1})([0-9]{4})$" AND first term of SSN is not "000" or "666" AND second term of SSN is not "00" AND third term of SSN is not "0000") OR (follows regex pattern "^([0-9]{3})(-{1})([0-9]{2})(-{1})([0-9]{4})$") BirthDate (DateTime) • birthYear > 1899 StreetAddress1 (string) • Not null • 0 <= length <= 30 StreetAddress2 (string) • 0 <= length <= 30 City (string) • Not null • 0 <= length <= 25 State (string) • Not null • 0 <= length <= 2 ZipCode (string) • Not null • 0 <= length <= 10 • Follows regex pattern "^[0-9]{5}(?:[-][0-9]{4})?$" Country (string) AreaCode (string) • 0 <= length <= 5 PhoneNumber (string) • 0 <= length <= 12 Sex (string) • 0 <= length 1 • Example: "M" for Male or "F" for Female • Not null SalaryAmount (number/float) HireDate (DateTime) • hireYear > 1899 JobCode (string) • Not null • 0 <= length <= 10 EmployeeStatusCode (string) • Not null • 0 <= length <= 10 PayrollSchedule (string) • 0 <= length <= 50 PayrollGroupCode (string) • Not null • 0 <= length <= 10 StateWitholding (string) • Not null • 0 <= length <= 4 StateUnemployment (string) • Not null • 0 <= length <= 4 EmployeeClassification (string) • Not null • 0 <= length <= 4 • Follows regex pattern "^(W2|1099|TIP)$ ignoring case MaritalStatus (string) • Not null • 0 <= length <= 10 FederalMaritalStatus (string) • Not null • 0 <= length <= 10 • Must be "M", "S", or "H" in most cases StateMaritalStatus (string) • Not null • 0 <= length <= 10 • Must be "M", "S", or "H" in most cases FederalExtraAmount (number/float) Position (string) • 0 <= length <= 30 PersonalEmailAddress (string) • Must be a valid email address UNLESS null or whitespace PrimaryContactMethod (string) • When this is "E", PersonalEmailAddress must be populated with a valid format email address • When this is "P", CellPhoneNumber and CellPhoneAreaCode must both be populated and in valid format PayrollScheduleId (string) RoutingNumber (string) • 0 <= length <= 9 • Must contain only digits • Must be valid routing number AccountNumber (string) • 0 <= length <= 17 • Not null or whitespace • Must contain only digits AccountType (string) • Not null or whitespace • 1 <= length <= 17 EffectiveDate (string) • Not null or whitespace DepositAmount (string) • Not null or whitespace • Must be either "balance" or "partial" • Case-insensitive IsStatusPrenote (bool) Location (string) • Not null • 0 <= length <= 4 |
Request body formats
application/json, text/json
Sample:
[ { "CompanyCode": "", "Division": "", "BusinessUnit": "", "Department": "", "Location": "", "FirstName": "", "MiddleName": "", "LastName": "", "SocialSecurityNumber": "", "BirthDate": "2000-01-01T00:00:00", "StreetAddress1": "", "StreetAddress2": "", "City": "", "State": "", "ZipCode": "", "Country": "", "County": "", "AreaCode": "", "PhoneNumber": "", "Sex": "", "SalaryAmount": 0.0, "HireDate": "2000-01-01T00:00:00", "TerminationDate": "2000-01-01T00:00:00", "JobCode": "", "EmployeeStatusCode": "", "EmployeePayType": "", "NormalUnitAmount": 0.0, "UnitRate": 0.0, "PayrollSchedule": "", "PayrollGroupCode": "", "AutoTimesheetIndicator": false, "PayPeriodAmount": 0.0, "StateWitholding": "", "StateUnemployment": "", "EmployeeClassification": "", "FederalMaritalStatus": "", "StateMaritalStatus": "", "PrimaryLocalMaritalStatus": "", "SecondaryLocalMaritalStatus": "", "FederalExemptions": 0, "StateExemptions": 0.0, "StateSpecialExemptions": 0.0, "PrimaryLocalExemptions": 0.0, "SecondaryLocalExemptions": 0.0, "FederalExtraAmount": 0.0, "StateExtraAmount": 0.0, "MaritalStatus": "", "Position": "", "CellPhoneAreaCode": "", "CellPhoneNumber": "", "PersonalEmailAddress": "", "PrimaryContactMethod": "", "PayrollScheduleId": 0, "MinimumWageCity": "", "MinimumWageState": "", "Race": "", "EeoClass": "", "Order": 0, "RoutingNumber": "", "AccountNumber": "", "AccountType": "", "EffectiveDate": "2000-01-01T00:00:00", "Status": "", "DepositAmount": "", "PartialAmount": 0.0, "PartialAmountType": "", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "", "FederalW4_2020_Ind": false, "FederalMultipleJobs": "", "FederalMultipleJobs_Ind": false, "FederalDependentTaxCredit_Amt": 0.0, "FederalOtherIncome_Amt": 0.0, "FederalDeductions_Amt": 0.0, "StateMultipleJobs": "", "StateMultipleJobs_Ind": false, "StateDependentTaxCredit_Amt": 0.0, "StateOtherIncome_Amt": 0.0, "StateDeductions_Amt": 0.0, "EmployeeSelfServiceUserAccess": "", "EmployeeCode": "" }, { "CompanyCode": "", "Division": "", "BusinessUnit": "", "Department": "", "Location": "", "FirstName": "", "MiddleName": "", "LastName": "", "SocialSecurityNumber": "", "BirthDate": "2000-01-01T00:00:00", "StreetAddress1": "", "StreetAddress2": "", "City": "", "State": "", "ZipCode": "", "Country": "", "County": "", "AreaCode": "", "PhoneNumber": "", "Sex": "", "SalaryAmount": 0.0, "HireDate": "2000-01-01T00:00:00", "TerminationDate": "2000-01-01T00:00:00", "JobCode": "", "EmployeeStatusCode": "", "EmployeePayType": "", "NormalUnitAmount": 0.0, "UnitRate": 0.0, "PayrollSchedule": "", "PayrollGroupCode": "", "AutoTimesheetIndicator": false, "PayPeriodAmount": 0.0, "StateWitholding": "", "StateUnemployment": "", "EmployeeClassification": "", "FederalMaritalStatus": "", "StateMaritalStatus": "", "PrimaryLocalMaritalStatus": "", "SecondaryLocalMaritalStatus": "", "FederalExemptions": 0, "StateExemptions": 0.0, "StateSpecialExemptions": 0.0, "PrimaryLocalExemptions": 0.0, "SecondaryLocalExemptions": 0.0, "FederalExtraAmount": 0.0, "StateExtraAmount": 0.0, "MaritalStatus": "", "Position": "", "CellPhoneAreaCode": "", "CellPhoneNumber": "", "PersonalEmailAddress": "", "PrimaryContactMethod": "", "PayrollScheduleId": 0, "MinimumWageCity": "", "MinimumWageState": "", "Race": "", "EeoClass": "", "Order": 0, "RoutingNumber": "", "AccountNumber": "", "AccountType": "", "EffectiveDate": "2000-01-01T00:00:00", "Status": "", "DepositAmount": "", "PartialAmount": 0.0, "PartialAmountType": "", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "", "FederalW4_2020_Ind": false, "FederalMultipleJobs": "", "FederalMultipleJobs_Ind": false, "FederalDependentTaxCredit_Amt": 0.0, "FederalOtherIncome_Amt": 0.0, "FederalDeductions_Amt": 0.0, "StateMultipleJobs": "", "StateMultipleJobs_Ind": false, "StateDependentTaxCredit_Amt": 0.0, "StateOtherIncome_Amt": 0.0, "StateDeductions_Amt": 0.0, "EmployeeSelfServiceUserAccess": "", "EmployeeCode": "" }, { "CompanyCode": "", "Division": "", "BusinessUnit": "", "Department": "", "Location": "", "FirstName": "", "MiddleName": "", "LastName": "", "SocialSecurityNumber": "", "BirthDate": "2000-01-01T00:00:00", "StreetAddress1": "", "StreetAddress2": "", "City": "", "State": "", "ZipCode": "", "Country": "", "County": "", "AreaCode": "", "PhoneNumber": "", "Sex": "", "SalaryAmount": 0.0, "HireDate": "2000-01-01T00:00:00", "TerminationDate": "2000-01-01T00:00:00", "JobCode": "", "EmployeeStatusCode": "", "EmployeePayType": "", "NormalUnitAmount": 0.0, "UnitRate": 0.0, "PayrollSchedule": "", "PayrollGroupCode": "", "AutoTimesheetIndicator": false, "PayPeriodAmount": 0.0, "StateWitholding": "", "StateUnemployment": "", "EmployeeClassification": "", "FederalMaritalStatus": "", "StateMaritalStatus": "", "PrimaryLocalMaritalStatus": "", "SecondaryLocalMaritalStatus": "", "FederalExemptions": 0, "StateExemptions": 0.0, "StateSpecialExemptions": 0.0, "PrimaryLocalExemptions": 0.0, "SecondaryLocalExemptions": 0.0, "FederalExtraAmount": 0.0, "StateExtraAmount": 0.0, "MaritalStatus": "", "Position": "", "CellPhoneAreaCode": "", "CellPhoneNumber": "", "PersonalEmailAddress": "", "PrimaryContactMethod": "", "PayrollScheduleId": 0, "MinimumWageCity": "", "MinimumWageState": "", "Race": "", "EeoClass": "", "Order": 0, "RoutingNumber": "", "AccountNumber": "", "AccountType": "", "EffectiveDate": "2000-01-01T00:00:00", "Status": "", "DepositAmount": "", "PartialAmount": 0.0, "PartialAmountType": "", "IsStatusPrenote": false, "IsPartialAmountTypePercentage": false, "IsDepositAmountBalance": false, "W4Form2020": "", "FederalW4_2020_Ind": false, "FederalMultipleJobs": "", "FederalMultipleJobs_Ind": false, "FederalDependentTaxCredit_Amt": 0.0, "FederalOtherIncome_Amt": 0.0, "FederalDeductions_Amt": 0.0, "StateMultipleJobs": "", "StateMultipleJobs_Ind": false, "StateDependentTaxCredit_Amt": 0.0, "StateOtherIncome_Amt": 0.0, "StateDeductions_Amt": 0.0, "EmployeeSelfServiceUserAccess": "", "EmployeeCode": "" } ]
application/xml, text/xml
Sample:
<ArrayOfNewHireImportDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.Internal.Core.Models.NetchexEmployee.External"> <NewHireImportDto> <AccountNumber></AccountNumber> <AccountType></AccountType> <AreaCode></AreaCode> <AutoTimesheetIndicator>false</AutoTimesheetIndicator> <BirthDate>2000-01-01T00:00:00</BirthDate> <BusinessUnit></BusinessUnit> <CellPhoneAreaCode></CellPhoneAreaCode> <CellPhoneNumber></CellPhoneNumber> <City></City> <CompanyCode></CompanyCode> <Country></Country> <County></County> <Department></Department> <DepositAmount></DepositAmount> <Division></Division> <EeoClass></EeoClass> <EffectiveDate>2000-01-01T00:00:00</EffectiveDate> <EmployeeClassification></EmployeeClassification> <EmployeeCode></EmployeeCode> <EmployeePayType></EmployeePayType> <EmployeeSelfServiceUserAccess></EmployeeSelfServiceUserAccess> <EmployeeStatusCode></EmployeeStatusCode> <FederalDeductions_Amt>0</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>0</FederalDependentTaxCredit_Amt> <FederalExemptions>0</FederalExemptions> <FederalExtraAmount>0</FederalExtraAmount> <FederalMaritalStatus></FederalMaritalStatus> <FederalMultipleJobs></FederalMultipleJobs> <FederalMultipleJobs_Ind>false</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>0</FederalOtherIncome_Amt> <FederalW4_2020_Ind>false</FederalW4_2020_Ind> <FirstName></FirstName> <HireDate>2000-01-01T00:00:00</HireDate> <JobCode></JobCode> <LastName></LastName> <Location></Location> <MaritalStatus></MaritalStatus> <MiddleName></MiddleName> <MinimumWageCity></MinimumWageCity> <MinimumWageState></MinimumWageState> <NormalUnitAmount>0</NormalUnitAmount> <Order>0</Order> <PartialAmount>0</PartialAmount> <PartialAmountType></PartialAmountType> <PayPeriodAmount>0</PayPeriodAmount> <PayrollGroupCode></PayrollGroupCode> <PayrollSchedule></PayrollSchedule> <PayrollScheduleId>0</PayrollScheduleId> <PersonalEmailAddress></PersonalEmailAddress> <PhoneNumber></PhoneNumber> <Position></Position> <PrimaryContactMethod></PrimaryContactMethod> <PrimaryLocalExemptions>0</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus></PrimaryLocalMaritalStatus> <Race></Race> <RoutingNumber></RoutingNumber> <SalaryAmount>0</SalaryAmount> <SecondaryLocalExemptions>0</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus></SecondaryLocalMaritalStatus> <Sex></Sex> <SocialSecurityNumber></SocialSecurityNumber> <State></State> <StateDeductions_Amt>0</StateDeductions_Amt> <StateDependentTaxCredit_Amt>0</StateDependentTaxCredit_Amt> <StateExemptions>0</StateExemptions> <StateExtraAmount>0</StateExtraAmount> <StateMaritalStatus></StateMaritalStatus> <StateMultipleJobs></StateMultipleJobs> <StateMultipleJobs_Ind>false</StateMultipleJobs_Ind> <StateOtherIncome_Amt>0</StateOtherIncome_Amt> <StateSpecialExemptions>0</StateSpecialExemptions> <StateUnemployment></StateUnemployment> <StateWitholding></StateWitholding> <Status></Status> <StreetAddress1></StreetAddress1> <StreetAddress2></StreetAddress2> <TerminationDate>2000-01-01T00:00:00</TerminationDate> <UnitRate>0</UnitRate> <W4Form2020></W4Form2020> <ZipCode></ZipCode> </NewHireImportDto> <NewHireImportDto> <AccountNumber></AccountNumber> <AccountType></AccountType> <AreaCode></AreaCode> <AutoTimesheetIndicator>false</AutoTimesheetIndicator> <BirthDate>2000-01-01T00:00:00</BirthDate> <BusinessUnit></BusinessUnit> <CellPhoneAreaCode></CellPhoneAreaCode> <CellPhoneNumber></CellPhoneNumber> <City></City> <CompanyCode></CompanyCode> <Country></Country> <County></County> <Department></Department> <DepositAmount></DepositAmount> <Division></Division> <EeoClass></EeoClass> <EffectiveDate>2000-01-01T00:00:00</EffectiveDate> <EmployeeClassification></EmployeeClassification> <EmployeeCode></EmployeeCode> <EmployeePayType></EmployeePayType> <EmployeeSelfServiceUserAccess></EmployeeSelfServiceUserAccess> <EmployeeStatusCode></EmployeeStatusCode> <FederalDeductions_Amt>0</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>0</FederalDependentTaxCredit_Amt> <FederalExemptions>0</FederalExemptions> <FederalExtraAmount>0</FederalExtraAmount> <FederalMaritalStatus></FederalMaritalStatus> <FederalMultipleJobs></FederalMultipleJobs> <FederalMultipleJobs_Ind>false</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>0</FederalOtherIncome_Amt> <FederalW4_2020_Ind>false</FederalW4_2020_Ind> <FirstName></FirstName> <HireDate>2000-01-01T00:00:00</HireDate> <JobCode></JobCode> <LastName></LastName> <Location></Location> <MaritalStatus></MaritalStatus> <MiddleName></MiddleName> <MinimumWageCity></MinimumWageCity> <MinimumWageState></MinimumWageState> <NormalUnitAmount>0</NormalUnitAmount> <Order>0</Order> <PartialAmount>0</PartialAmount> <PartialAmountType></PartialAmountType> <PayPeriodAmount>0</PayPeriodAmount> <PayrollGroupCode></PayrollGroupCode> <PayrollSchedule></PayrollSchedule> <PayrollScheduleId>0</PayrollScheduleId> <PersonalEmailAddress></PersonalEmailAddress> <PhoneNumber></PhoneNumber> <Position></Position> <PrimaryContactMethod></PrimaryContactMethod> <PrimaryLocalExemptions>0</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus></PrimaryLocalMaritalStatus> <Race></Race> <RoutingNumber></RoutingNumber> <SalaryAmount>0</SalaryAmount> <SecondaryLocalExemptions>0</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus></SecondaryLocalMaritalStatus> <Sex></Sex> <SocialSecurityNumber></SocialSecurityNumber> <State></State> <StateDeductions_Amt>0</StateDeductions_Amt> <StateDependentTaxCredit_Amt>0</StateDependentTaxCredit_Amt> <StateExemptions>0</StateExemptions> <StateExtraAmount>0</StateExtraAmount> <StateMaritalStatus></StateMaritalStatus> <StateMultipleJobs></StateMultipleJobs> <StateMultipleJobs_Ind>false</StateMultipleJobs_Ind> <StateOtherIncome_Amt>0</StateOtherIncome_Amt> <StateSpecialExemptions>0</StateSpecialExemptions> <StateUnemployment></StateUnemployment> <StateWitholding></StateWitholding> <Status></Status> <StreetAddress1></StreetAddress1> <StreetAddress2></StreetAddress2> <TerminationDate>2000-01-01T00:00:00</TerminationDate> <UnitRate>0</UnitRate> <W4Form2020></W4Form2020> <ZipCode></ZipCode> </NewHireImportDto> <NewHireImportDto> <AccountNumber></AccountNumber> <AccountType></AccountType> <AreaCode></AreaCode> <AutoTimesheetIndicator>false</AutoTimesheetIndicator> <BirthDate>2000-01-01T00:00:00</BirthDate> <BusinessUnit></BusinessUnit> <CellPhoneAreaCode></CellPhoneAreaCode> <CellPhoneNumber></CellPhoneNumber> <City></City> <CompanyCode></CompanyCode> <Country></Country> <County></County> <Department></Department> <DepositAmount></DepositAmount> <Division></Division> <EeoClass></EeoClass> <EffectiveDate>2000-01-01T00:00:00</EffectiveDate> <EmployeeClassification></EmployeeClassification> <EmployeeCode></EmployeeCode> <EmployeePayType></EmployeePayType> <EmployeeSelfServiceUserAccess></EmployeeSelfServiceUserAccess> <EmployeeStatusCode></EmployeeStatusCode> <FederalDeductions_Amt>0</FederalDeductions_Amt> <FederalDependentTaxCredit_Amt>0</FederalDependentTaxCredit_Amt> <FederalExemptions>0</FederalExemptions> <FederalExtraAmount>0</FederalExtraAmount> <FederalMaritalStatus></FederalMaritalStatus> <FederalMultipleJobs></FederalMultipleJobs> <FederalMultipleJobs_Ind>false</FederalMultipleJobs_Ind> <FederalOtherIncome_Amt>0</FederalOtherIncome_Amt> <FederalW4_2020_Ind>false</FederalW4_2020_Ind> <FirstName></FirstName> <HireDate>2000-01-01T00:00:00</HireDate> <JobCode></JobCode> <LastName></LastName> <Location></Location> <MaritalStatus></MaritalStatus> <MiddleName></MiddleName> <MinimumWageCity></MinimumWageCity> <MinimumWageState></MinimumWageState> <NormalUnitAmount>0</NormalUnitAmount> <Order>0</Order> <PartialAmount>0</PartialAmount> <PartialAmountType></PartialAmountType> <PayPeriodAmount>0</PayPeriodAmount> <PayrollGroupCode></PayrollGroupCode> <PayrollSchedule></PayrollSchedule> <PayrollScheduleId>0</PayrollScheduleId> <PersonalEmailAddress></PersonalEmailAddress> <PhoneNumber></PhoneNumber> <Position></Position> <PrimaryContactMethod></PrimaryContactMethod> <PrimaryLocalExemptions>0</PrimaryLocalExemptions> <PrimaryLocalMaritalStatus></PrimaryLocalMaritalStatus> <Race></Race> <RoutingNumber></RoutingNumber> <SalaryAmount>0</SalaryAmount> <SecondaryLocalExemptions>0</SecondaryLocalExemptions> <SecondaryLocalMaritalStatus></SecondaryLocalMaritalStatus> <Sex></Sex> <SocialSecurityNumber></SocialSecurityNumber> <State></State> <StateDeductions_Amt>0</StateDeductions_Amt> <StateDependentTaxCredit_Amt>0</StateDependentTaxCredit_Amt> <StateExemptions>0</StateExemptions> <StateExtraAmount>0</StateExtraAmount> <StateMaritalStatus></StateMaritalStatus> <StateMultipleJobs></StateMultipleJobs> <StateMultipleJobs_Ind>false</StateMultipleJobs_Ind> <StateOtherIncome_Amt>0</StateOtherIncome_Amt> <StateSpecialExemptions>0</StateSpecialExemptions> <StateUnemployment></StateUnemployment> <StateWitholding></StateWitholding> <Status></Status> <StreetAddress1></StreetAddress1> <StreetAddress2></StreetAddress2> <TerminationDate>2000-01-01T00:00:00</TerminationDate> <UnitRate>0</UnitRate> <W4Form2020></W4Form2020> <ZipCode></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.