POST v1/ats/import/employee-onboarding-requests?allowSameFile={allowSameFile}

Import Employee Onboarding Requests

Request Information

URI Parameters

Name	Description	Type	Additional information
allowSameFile		boolean	Default value is True

Body Parameters

Collection of OnboardingEmployeeImportDTO

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
MiddleInitial	character	None.
Suffix	string	None.
Nickname	string	None.
Email	string	None.
JobTitle	string	None.
HireDate	date	None.
FullOrPartTime	FullOrPartTime	None.
TaxType	EETaxType	None.
HomePhone	string	None.
MobilePhone	string	None.
WorkPhone	string	None.
PayType	PayType	None.
BaseRate	decimal number	None.
PayFrequency	PayFrequency	None.
Address	AddressDTO	None.
CostCenter1Code	string	None.
CostCenter2Code	string	None.
CostCenter3Code	string	None.
CostCenter4Code	string	None.
CostCenter5Code	string	None.
JobCode	string	None.
WorkLocationCode	string	None.
SendOnboardingRequestAutomatic	boolean	None.
BenefitCategoryCode	string	None.
EmployeeNumber	string	None.
OnboardingPlanCode	string	None.
StandardHours	decimal number	None.
AutoPay	boolean	None.
IsTobaccoUser	boolean	None.
PayGroup	string	None.
TaxFormDeliveryMethod	EmployeeDeliveryMethod	None.
PayStubDeliveryMethod	EmployeeDeliveryMethod	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "middleInitial": "A",
    "suffix": "sample string 3",
    "nickname": "sample string 4",
    "email": "sample string 5",
    "jobTitle": "sample string 6",
    "hireDate": "0001-02-03",
    "fullOrPartTime": "FullTime",
    "taxType": "W2",
    "homePhone": "sample string 7",
    "mobilePhone": "sample string 8",
    "workPhone": "sample string 9",
    "payType": "Salary",
    "baseRate": 1.0,
    "payFrequency": "YEAR",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "costCenter1Code": "sample string 10",
    "costCenter2Code": "sample string 11",
    "costCenter3Code": "sample string 12",
    "costCenter4Code": "sample string 13",
    "costCenter5Code": "sample string 14",
    "jobCode": "sample string 15",
    "workLocationCode": "sample string 16",
    "sendOnboardingRequestAutomatic": true,
    "benefitCategoryCode": "sample string 18",
    "employeeNumber": "sample string 19",
    "onboardingPlanCode": "sample string 20",
    "standardHours": 1.0,
    "autoPay": true,
    "isTobaccoUser": true,
    "payGroup": "sample string 21",
    "taxFormDeliveryMethod": "Paper",
    "payStubDeliveryMethod": "Paper",
    "divisionCode": "sample string 22",
    "companyCode": "sample string 23"
  },
  {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "middleInitial": "A",
    "suffix": "sample string 3",
    "nickname": "sample string 4",
    "email": "sample string 5",
    "jobTitle": "sample string 6",
    "hireDate": "0001-02-03",
    "fullOrPartTime": "FullTime",
    "taxType": "W2",
    "homePhone": "sample string 7",
    "mobilePhone": "sample string 8",
    "workPhone": "sample string 9",
    "payType": "Salary",
    "baseRate": 1.0,
    "payFrequency": "YEAR",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "costCenter1Code": "sample string 10",
    "costCenter2Code": "sample string 11",
    "costCenter3Code": "sample string 12",
    "costCenter4Code": "sample string 13",
    "costCenter5Code": "sample string 14",
    "jobCode": "sample string 15",
    "workLocationCode": "sample string 16",
    "sendOnboardingRequestAutomatic": true,
    "benefitCategoryCode": "sample string 18",
    "employeeNumber": "sample string 19",
    "onboardingPlanCode": "sample string 20",
    "standardHours": 1.0,
    "autoPay": true,
    "isTobaccoUser": true,
    "payGroup": "sample string 21",
    "taxFormDeliveryMethod": "Paper",
    "payStubDeliveryMethod": "Paper",
    "divisionCode": "sample string 22",
    "companyCode": "sample string 23"
  }
]

text/xml

Sample:

<ArrayOfOnboardingEmployeeImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <OnboardingEmployeeImportDTO>
    <CompanyCode>sample string 23</CompanyCode>
    <DivisionCode>sample string 22</DivisionCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AutoPay>true</AutoPay>
    <BaseRate>1</BaseRate>
    <BenefitCategoryCode>sample string 18</BenefitCategoryCode>
    <CostCenter1Code>sample string 10</CostCenter1Code>
    <CostCenter2Code>sample string 11</CostCenter2Code>
    <CostCenter3Code>sample string 12</CostCenter3Code>
    <CostCenter4Code>sample string 13</CostCenter4Code>
    <CostCenter5Code>sample string 14</CostCenter5Code>
    <Email>sample string 5</Email>
    <EmployeeNumber>sample string 19</EmployeeNumber>
    <FirstName>sample string 1</FirstName>
    <FullOrPartTime>FullTime</FullOrPartTime>
    <HireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </HireDate>
    <HomePhone>sample string 7</HomePhone>
    <IsTobaccoUser>true</IsTobaccoUser>
    <JobCode>sample string 15</JobCode>
    <JobTitle>sample string 6</JobTitle>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 8</MobilePhone>
    <Nickname>sample string 4</Nickname>
    <OnboardingPlanCode>sample string 20</OnboardingPlanCode>
    <PayFrequency>YEAR</PayFrequency>
    <PayGroup>sample string 21</PayGroup>
    <PayStubDeliveryMethod>Paper</PayStubDeliveryMethod>
    <PayType>Salary</PayType>
    <SendOnboardingRequestAutomatic>true</SendOnboardingRequestAutomatic>
    <StandardHours>1</StandardHours>
    <Suffix>sample string 3</Suffix>
    <TaxFormDeliveryMethod>Paper</TaxFormDeliveryMethod>
    <TaxType>W2</TaxType>
    <WorkLocationCode>sample string 16</WorkLocationCode>
    <WorkPhone>sample string 9</WorkPhone>
  </OnboardingEmployeeImportDTO>
  <OnboardingEmployeeImportDTO>
    <CompanyCode>sample string 23</CompanyCode>
    <DivisionCode>sample string 22</DivisionCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AutoPay>true</AutoPay>
    <BaseRate>1</BaseRate>
    <BenefitCategoryCode>sample string 18</BenefitCategoryCode>
    <CostCenter1Code>sample string 10</CostCenter1Code>
    <CostCenter2Code>sample string 11</CostCenter2Code>
    <CostCenter3Code>sample string 12</CostCenter3Code>
    <CostCenter4Code>sample string 13</CostCenter4Code>
    <CostCenter5Code>sample string 14</CostCenter5Code>
    <Email>sample string 5</Email>
    <EmployeeNumber>sample string 19</EmployeeNumber>
    <FirstName>sample string 1</FirstName>
    <FullOrPartTime>FullTime</FullOrPartTime>
    <HireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </HireDate>
    <HomePhone>sample string 7</HomePhone>
    <IsTobaccoUser>true</IsTobaccoUser>
    <JobCode>sample string 15</JobCode>
    <JobTitle>sample string 6</JobTitle>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 8</MobilePhone>
    <Nickname>sample string 4</Nickname>
    <OnboardingPlanCode>sample string 20</OnboardingPlanCode>
    <PayFrequency>YEAR</PayFrequency>
    <PayGroup>sample string 21</PayGroup>
    <PayStubDeliveryMethod>Paper</PayStubDeliveryMethod>
    <PayType>Salary</PayType>
    <SendOnboardingRequestAutomatic>true</SendOnboardingRequestAutomatic>
    <StandardHours>1</StandardHours>
    <Suffix>sample string 3</Suffix>
    <TaxFormDeliveryMethod>Paper</TaxFormDeliveryMethod>
    <TaxType>W2</TaxType>
    <WorkLocationCode>sample string 16</WorkLocationCode>
    <WorkPhone>sample string 9</WorkPhone>
  </OnboardingEmployeeImportDTO>
</ArrayOfOnboardingEmployeeImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.