POST v1/Employees/UpdateEmployeeForOnOnboarding

Onboard an employee to payroll expecting the employee to be in the system

Request Information

URI Parameters

None.

Body Parameters

The Employee Onboarding Data Object.

Name	Description	Type	Additional information
Employee	Onboarding employee object	Employee	None.
ClockSerialList	the clocks serial numbers the employee should be enrolled on(valid serial number required)	Dictionary of string [key] and boolean [value]	None.
DocumentList	the documents the employee needs to sign( valid document name required)	Dictionary of string [key] and boolean [value]	None.
PayRate	the pay rate for this employee	decimal number	None.
SelfEnroll	true to send a self service enrollment email for the employee to fill out the rest of the informaiton	boolean	None.
SkipI9	true to skip the I9 verification process for the employee	boolean	None.
TaxWorkLocation	the employee tax work location code	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Employee": {
    "EmployeeID": 1,
    "EmployeePersonalID": 2,
    "DivisionID": 3,
    "EmployeeNumber": "sample string 4",
    "DivisionEmployeeStatus": "sample string 5",
    "PayGroup": "sample string 6",
    "Location": "sample string 7",
    "Job": "sample string 8",
    "Position": "sample string 9",
    "JobTitle": "sample string 10",
    "ClockNumber": "sample string 11",
    "IsExemptFromOT": true,
    "FullOrPartTime": "sample string 13",
    "HireDate": "2023-12-05T10:21:00.3225928-05:00",
    "PayType": "sample string 14",
    "AutoPay": true,
    "SSN": "sample string 16",
    "FirstName": "sample string 17",
    "MiddleInitial": "A",
    "LastName": "sample string 19",
    "CostCenter1": "sample string 20",
    "CostCenter2": "sample string 21",
    "CostCenter3": "sample string 22",
    "CostCenter4": "sample string 23",
    "CostCenter5": "sample string 24",
    "FirstLast": "sample string 25",
    "LastFirst": "sample string 26",
    "Address1": "sample string 27",
    "Address2": "sample string 28",
    "City": "sample string 29",
    "State": "sample string 30",
    "ZipCode": "sample string 31",
    "Phone": "sample string 32",
    "Email": "sample string 33",
    "DOB": "2023-12-05T10:21:00.3225928-05:00",
    "Gender": "sample string 34",
    "ClockStatus": "sample string 35",
    "ModifiedOn": "2023-12-05T10:21:00.3225928-05:00",
    "IsASupervisor": true,
    "SupervisorID": 1,
    "SupervisorEmployeeNumber": "sample string 38",
    "DoNotTransferHoursToPayroll": true,
    "TerminationDate": "2023-12-05T10:21:00.3225928-05:00",
    "StandardHours": 40.0,
    "WorkPhone": "sample string 41",
    "WorkPhoneExt": "sample string 42",
    "MobilePhone": "sample string 43",
    "PersonalEmail": "sample string 44",
    "Task": "sample string 45",
    "Occupation": "sample string 46",
    "EthnicCode": "sample string 47",
    "FLSACode": "sample string 48",
    "PayFrequency": "sample string 49",
    "EETaxType": "sample string 50",
    "TaxLocation": "sample string 51",
    "SkipI9Verification": true,
    "PayMethod": 53,
    "WorkersCompCode": "sample string 54",
    "ExcludeFromWorkersComp": true,
    "NewHireStatus": 56,
    "BenefitClassCode": "sample string 57",
    "RehireDate": "2023-12-05T10:21:00.3225928-05:00",
    "AutoGrossUp": true,
    "IsStatutory": true,
    "CustomFieldData": "sample string 60",
    "UseNewW4": true,
    "TermReason": "sample string 62",
    "OnBoardingStatus": 1,
    "UseHomeTaxWorkLocation": true,
    "SOCCode": "sample string 63"
  },
  "ClockSerialList": {
    "sample string 1": true,
    "sample string 3": true
  },
  "DocumentList": {
    "sample string 1": true,
    "sample string 3": true
  },
  "PayRate": 1.0,
  "SelfEnroll": true,
  "SkipI9": true,
  "TaxWorkLocation": "sample string 3"
}

application/xml, text/xml

Sample:

<EmployeeOnboardingData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <ClockSerialList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </ClockSerialList>
  <DocumentList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>true</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </DocumentList>
  <Employee xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.Entities">
    <d2p1:EmployeeID>1</d2p1:EmployeeID>
    <d2p1:EmployeePersonalID>2</d2p1:EmployeePersonalID>
    <d2p1:DivisionID>3</d2p1:DivisionID>
    <d2p1:EmployeeNumber>sample string 4</d2p1:EmployeeNumber>
    <d2p1:DivisionEmployeeStatus>sample string 5</d2p1:DivisionEmployeeStatus>
    <d2p1:PayGroup>sample string 6</d2p1:PayGroup>
    <d2p1:Location>sample string 7</d2p1:Location>
    <d2p1:Job>sample string 8</d2p1:Job>
    <d2p1:Position>sample string 9</d2p1:Position>
    <d2p1:JobTitle>sample string 10</d2p1:JobTitle>
    <d2p1:ClockNumber>sample string 11</d2p1:ClockNumber>
    <d2p1:IsExemptFromOT>true</d2p1:IsExemptFromOT>
    <d2p1:FullOrPartTime>sample string 13</d2p1:FullOrPartTime>
    <d2p1:HireDate>2023-12-05T10:21:00.3225928-05:00</d2p1:HireDate>
    <d2p1:PayType>sample string 14</d2p1:PayType>
    <d2p1:AutoPay>true</d2p1:AutoPay>
    <d2p1:SSN>sample string 16</d2p1:SSN>
    <d2p1:FirstName>sample string 17</d2p1:FirstName>
    <d2p1:MiddleInitial>65</d2p1:MiddleInitial>
    <d2p1:LastName>sample string 19</d2p1:LastName>
    <d2p1:CostCenter1>sample string 20</d2p1:CostCenter1>
    <d2p1:CostCenter2>sample string 21</d2p1:CostCenter2>
    <d2p1:CostCenter3>sample string 22</d2p1:CostCenter3>
    <d2p1:CostCenter4>sample string 23</d2p1:CostCenter4>
    <d2p1:CostCenter5>sample string 24</d2p1:CostCenter5>
    <d2p1:FirstLast>sample string 25</d2p1:FirstLast>
    <d2p1:LastFirst>sample string 26</d2p1:LastFirst>
    <d2p1:Address1>sample string 27</d2p1:Address1>
    <d2p1:Address2>sample string 28</d2p1:Address2>
    <d2p1:City>sample string 29</d2p1:City>
    <d2p1:State>sample string 30</d2p1:State>
    <d2p1:ZipCode>sample string 31</d2p1:ZipCode>
    <d2p1:Phone>sample string 32</d2p1:Phone>
    <d2p1:Email>sample string 33</d2p1:Email>
    <d2p1:DOB>2023-12-05T10:21:00.3225928-05:00</d2p1:DOB>
    <d2p1:Gender>sample string 34</d2p1:Gender>
    <d2p1:ClockStatus>sample string 35</d2p1:ClockStatus>
    <d2p1:ModifiedOn>2023-12-05T10:21:00.3225928-05:00</d2p1:ModifiedOn>
    <d2p1:IsASupervisor>true</d2p1:IsASupervisor>
    <d2p1:SupervisorID>1</d2p1:SupervisorID>
    <d2p1:SupervisorEmployeeNumber>sample string 38</d2p1:SupervisorEmployeeNumber>
    <d2p1:DoNotTransferHoursToPayroll>true</d2p1:DoNotTransferHoursToPayroll>
    <d2p1:TerminationDate>2023-12-05T10:21:00.3225928-05:00</d2p1:TerminationDate>
    <d2p1:StandardHours>40</d2p1:StandardHours>
    <d2p1:WorkPhone>sample string 41</d2p1:WorkPhone>
    <d2p1:WorkPhoneExt>sample string 42</d2p1:WorkPhoneExt>
    <d2p1:MobilePhone>sample string 43</d2p1:MobilePhone>
    <d2p1:PersonalEmail>sample string 44</d2p1:PersonalEmail>
    <d2p1:Task>sample string 45</d2p1:Task>
    <d2p1:Occupation>sample string 46</d2p1:Occupation>
    <d2p1:EthnicCode>sample string 47</d2p1:EthnicCode>
    <d2p1:FLSACode>sample string 48</d2p1:FLSACode>
    <d2p1:PayFrequency>sample string 49</d2p1:PayFrequency>
    <d2p1:EETaxType>sample string 50</d2p1:EETaxType>
    <d2p1:TaxLocation>sample string 51</d2p1:TaxLocation>
    <d2p1:SkipI9Verification>true</d2p1:SkipI9Verification>
    <d2p1:PayMethod>53</d2p1:PayMethod>
    <d2p1:WorkersCompCode>sample string 54</d2p1:WorkersCompCode>
    <d2p1:ExcludeFromWorkersComp>true</d2p1:ExcludeFromWorkersComp>
    <d2p1:NewHireStatus>56</d2p1:NewHireStatus>
    <d2p1:BenefitClassCode>sample string 57</d2p1:BenefitClassCode>
    <d2p1:RehireDate>2023-12-05T10:21:00.3225928-05:00</d2p1:RehireDate>
    <d2p1:AutoGrossUp>true</d2p1:AutoGrossUp>
    <d2p1:IsStatutory>true</d2p1:IsStatutory>
    <d2p1:CustomFieldData>sample string 60</d2p1:CustomFieldData>
    <d2p1:UseNewW4>true</d2p1:UseNewW4>
    <d2p1:TermReason>sample string 62</d2p1:TermReason>
    <d2p1:OnBoardingStatus>1</d2p1:OnBoardingStatus>
    <d2p1:UseHomeTaxWorkLocation>true</d2p1:UseHomeTaxWorkLocation>
    <d2p1:SOCCode>sample string 63</d2p1:SOCCode>
  </Employee>
  <PayRate>1</PayRate>
  <SelfEnroll>true</SelfEnroll>
  <SkipI9>true</SkipI9>
  <TaxWorkLocation>sample string 3</TaxWorkLocation>
</EmployeeOnboardingData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.