POST v1/Employees/SynchronizeEmployees
Synchronize Employee Data to the system. Parameter is Employee Object. Employee Number is the Data Key for proper updating
Request Information
URI Parameters
None.
Body Parameters
The Employee Object.
Collection of EmployeeName | Description | Type | Additional information |
---|---|---|---|
EmployeeID | integer |
None. |
|
EmployeePersonalID | integer |
None. |
|
DivisionID | integer |
None. |
|
EmployeeNumber | string |
None. |
|
DivisionEmployeeStatus | string |
None. |
|
PayGroup | string |
None. |
|
Location | string |
None. |
|
Job | string |
None. |
|
Position | string |
None. |
|
JobTitle | string |
None. |
|
ClockNumber | string |
None. |
|
IsExemptFromOT | boolean |
None. |
|
FullOrPartTime | string |
None. |
|
HireDate | date |
None. |
|
PayType | string |
None. |
|
AutoPay | boolean |
None. |
|
SSN | string |
None. |
|
FirstName | string |
None. |
|
MiddleInitial | character |
None. |
|
LastName | string |
None. |
|
CostCenter1 | string |
None. |
|
CostCenter2 | string |
None. |
|
CostCenter3 | string |
None. |
|
CostCenter4 | string |
None. |
|
CostCenter5 | string |
None. |
|
FirstLast | string |
None. |
|
LastFirst | string |
None. |
|
Address1 | string |
None. |
|
Address2 | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
ZipCode | string |
None. |
|
Phone | string |
None. |
|
string |
None. |
||
DOB | date |
None. |
|
Gender | string |
None. |
|
ClockStatus | string |
None. |
|
ModifiedOn | date |
None. |
|
IsASupervisor | boolean |
None. |
|
SupervisorID | integer |
None. |
|
SupervisorEmployeeNumber | string |
None. |
|
DoNotTransferHoursToPayroll | boolean |
None. |
|
TerminationDate | date |
None. |
|
StandardHours | decimal number |
None. |
|
WorkPhone | string |
None. |
|
WorkPhoneExt | string |
None. |
|
MobilePhone | string |
None. |
|
PersonalEmail | string |
None. |
|
Task | string |
None. |
|
Occupation | string |
None. |
|
EthnicCode | string |
None. |
|
FLSACode | string |
None. |
|
PayFrequency | string |
None. |
|
EETaxType | string |
None. |
|
TaxLocation | string |
None. |
|
SkipI9Verification | boolean |
None. |
|
PayMethod | integer |
None. |
|
WorkersCompCode | string |
None. |
|
ExcludeFromWorkersComp | boolean |
None. |
|
NewHireStatus | integer |
None. |
|
BenefitClassCode | string |
None. |
|
RehireDate | date |
None. |
|
AutoGrossUp | boolean |
None. |
|
IsStatutory | boolean |
None. |
|
CustomFieldData | string |
None. |
|
UseNewW4 | boolean |
None. |
|
TermReason | string |
None. |
|
OnBoardingStatus | integer |
None. |
|
UseHomeTaxWorkLocation | boolean |
None. |
|
SOCCode | string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "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": "2024-04-19T16:59:18.5131003-04: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": "2024-04-19T16:59:18.5131003-04:00", "Gender": "sample string 34", "ClockStatus": "sample string 35", "ModifiedOn": "2024-04-19T16:59:18.5131003-04:00", "IsASupervisor": true, "SupervisorID": 1, "SupervisorEmployeeNumber": "sample string 38", "DoNotTransferHoursToPayroll": true, "TerminationDate": "2024-04-19T16:59:18.5131003-04: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": "2024-04-19T16:59:18.5131003-04:00", "AutoGrossUp": true, "IsStatutory": true, "CustomFieldData": "sample string 60", "UseNewW4": true, "TermReason": "sample string 62", "OnBoardingStatus": 1, "UseHomeTaxWorkLocation": true, "SOCCode": "sample string 63" }, { "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": "2024-04-19T16:59:18.5131003-04: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": "2024-04-19T16:59:18.5131003-04:00", "Gender": "sample string 34", "ClockStatus": "sample string 35", "ModifiedOn": "2024-04-19T16:59:18.5131003-04:00", "IsASupervisor": true, "SupervisorID": 1, "SupervisorEmployeeNumber": "sample string 38", "DoNotTransferHoursToPayroll": true, "TerminationDate": "2024-04-19T16:59:18.5131003-04: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": "2024-04-19T16:59:18.5131003-04:00", "AutoGrossUp": true, "IsStatutory": true, "CustomFieldData": "sample string 60", "UseNewW4": true, "TermReason": "sample string 62", "OnBoardingStatus": 1, "UseHomeTaxWorkLocation": true, "SOCCode": "sample string 63" } ]
application/xml, text/xml
Sample:
<ArrayOfEmployee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.Entities"> <Employee> <EmployeeID>1</EmployeeID> <EmployeePersonalID>2</EmployeePersonalID> <DivisionID>3</DivisionID> <EmployeeNumber>sample string 4</EmployeeNumber> <DivisionEmployeeStatus>sample string 5</DivisionEmployeeStatus> <PayGroup>sample string 6</PayGroup> <Location>sample string 7</Location> <Job>sample string 8</Job> <Position>sample string 9</Position> <JobTitle>sample string 10</JobTitle> <ClockNumber>sample string 11</ClockNumber> <IsExemptFromOT>true</IsExemptFromOT> <FullOrPartTime>sample string 13</FullOrPartTime> <HireDate>2024-04-19T16:59:18.5131003-04:00</HireDate> <PayType>sample string 14</PayType> <AutoPay>true</AutoPay> <SSN>sample string 16</SSN> <FirstName>sample string 17</FirstName> <MiddleInitial>65</MiddleInitial> <LastName>sample string 19</LastName> <CostCenter1>sample string 20</CostCenter1> <CostCenter2>sample string 21</CostCenter2> <CostCenter3>sample string 22</CostCenter3> <CostCenter4>sample string 23</CostCenter4> <CostCenter5>sample string 24</CostCenter5> <FirstLast>sample string 25</FirstLast> <LastFirst>sample string 26</LastFirst> <Address1>sample string 27</Address1> <Address2>sample string 28</Address2> <City>sample string 29</City> <State>sample string 30</State> <ZipCode>sample string 31</ZipCode> <Phone>sample string 32</Phone> <Email>sample string 33</Email> <DOB>2024-04-19T16:59:18.5131003-04:00</DOB> <Gender>sample string 34</Gender> <ClockStatus>sample string 35</ClockStatus> <ModifiedOn>2024-04-19T16:59:18.5131003-04:00</ModifiedOn> <IsASupervisor>true</IsASupervisor> <SupervisorID>1</SupervisorID> <SupervisorEmployeeNumber>sample string 38</SupervisorEmployeeNumber> <DoNotTransferHoursToPayroll>true</DoNotTransferHoursToPayroll> <TerminationDate>2024-04-19T16:59:18.5131003-04:00</TerminationDate> <StandardHours>40</StandardHours> <WorkPhone>sample string 41</WorkPhone> <WorkPhoneExt>sample string 42</WorkPhoneExt> <MobilePhone>sample string 43</MobilePhone> <PersonalEmail>sample string 44</PersonalEmail> <Task>sample string 45</Task> <Occupation>sample string 46</Occupation> <EthnicCode>sample string 47</EthnicCode> <FLSACode>sample string 48</FLSACode> <PayFrequency>sample string 49</PayFrequency> <EETaxType>sample string 50</EETaxType> <TaxLocation>sample string 51</TaxLocation> <SkipI9Verification>true</SkipI9Verification> <PayMethod>53</PayMethod> <WorkersCompCode>sample string 54</WorkersCompCode> <ExcludeFromWorkersComp>true</ExcludeFromWorkersComp> <NewHireStatus>56</NewHireStatus> <BenefitClassCode>sample string 57</BenefitClassCode> <RehireDate>2024-04-19T16:59:18.5131003-04:00</RehireDate> <AutoGrossUp>true</AutoGrossUp> <IsStatutory>true</IsStatutory> <CustomFieldData>sample string 60</CustomFieldData> <UseNewW4>true</UseNewW4> <TermReason>sample string 62</TermReason> <OnBoardingStatus>1</OnBoardingStatus> <UseHomeTaxWorkLocation>true</UseHomeTaxWorkLocation> <SOCCode>sample string 63</SOCCode> </Employee> <Employee> <EmployeeID>1</EmployeeID> <EmployeePersonalID>2</EmployeePersonalID> <DivisionID>3</DivisionID> <EmployeeNumber>sample string 4</EmployeeNumber> <DivisionEmployeeStatus>sample string 5</DivisionEmployeeStatus> <PayGroup>sample string 6</PayGroup> <Location>sample string 7</Location> <Job>sample string 8</Job> <Position>sample string 9</Position> <JobTitle>sample string 10</JobTitle> <ClockNumber>sample string 11</ClockNumber> <IsExemptFromOT>true</IsExemptFromOT> <FullOrPartTime>sample string 13</FullOrPartTime> <HireDate>2024-04-19T16:59:18.5131003-04:00</HireDate> <PayType>sample string 14</PayType> <AutoPay>true</AutoPay> <SSN>sample string 16</SSN> <FirstName>sample string 17</FirstName> <MiddleInitial>65</MiddleInitial> <LastName>sample string 19</LastName> <CostCenter1>sample string 20</CostCenter1> <CostCenter2>sample string 21</CostCenter2> <CostCenter3>sample string 22</CostCenter3> <CostCenter4>sample string 23</CostCenter4> <CostCenter5>sample string 24</CostCenter5> <FirstLast>sample string 25</FirstLast> <LastFirst>sample string 26</LastFirst> <Address1>sample string 27</Address1> <Address2>sample string 28</Address2> <City>sample string 29</City> <State>sample string 30</State> <ZipCode>sample string 31</ZipCode> <Phone>sample string 32</Phone> <Email>sample string 33</Email> <DOB>2024-04-19T16:59:18.5131003-04:00</DOB> <Gender>sample string 34</Gender> <ClockStatus>sample string 35</ClockStatus> <ModifiedOn>2024-04-19T16:59:18.5131003-04:00</ModifiedOn> <IsASupervisor>true</IsASupervisor> <SupervisorID>1</SupervisorID> <SupervisorEmployeeNumber>sample string 38</SupervisorEmployeeNumber> <DoNotTransferHoursToPayroll>true</DoNotTransferHoursToPayroll> <TerminationDate>2024-04-19T16:59:18.5131003-04:00</TerminationDate> <StandardHours>40</StandardHours> <WorkPhone>sample string 41</WorkPhone> <WorkPhoneExt>sample string 42</WorkPhoneExt> <MobilePhone>sample string 43</MobilePhone> <PersonalEmail>sample string 44</PersonalEmail> <Task>sample string 45</Task> <Occupation>sample string 46</Occupation> <EthnicCode>sample string 47</EthnicCode> <FLSACode>sample string 48</FLSACode> <PayFrequency>sample string 49</PayFrequency> <EETaxType>sample string 50</EETaxType> <TaxLocation>sample string 51</TaxLocation> <SkipI9Verification>true</SkipI9Verification> <PayMethod>53</PayMethod> <WorkersCompCode>sample string 54</WorkersCompCode> <ExcludeFromWorkersComp>true</ExcludeFromWorkersComp> <NewHireStatus>56</NewHireStatus> <BenefitClassCode>sample string 57</BenefitClassCode> <RehireDate>2024-04-19T16:59:18.5131003-04:00</RehireDate> <AutoGrossUp>true</AutoGrossUp> <IsStatutory>true</IsStatutory> <CustomFieldData>sample string 60</CustomFieldData> <UseNewW4>true</UseNewW4> <TermReason>sample string 62</TermReason> <OnBoardingStatus>1</OnBoardingStatus> <UseHomeTaxWorkLocation>true</UseHomeTaxWorkLocation> <SOCCode>sample string 63</SOCCode> </Employee> </ArrayOfEmployee>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | 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. |