GET v1/ams/{externalPartner}/export/divisions/{divisionId}/external-employees?externalKey={externalKey}&includeCustomFields={includeCustomFields}

Request Information

URI Parameters

Name	Type	Additional information
externalPartner	ExternalPartners	Required
divisionId	string	Required
externalKey	string	Required
includeCustomFields	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

AMSEmployeeDTO

Name	Type	Additional information
SSN	string	None.
Address	AddressDTO	None.
WorkPhone	string	None.
MobilePhone	string	None.
Fax	string	None.
Gender	Gender	None.
JobTitle	string	None.
RehireDate	date	None.
BirthDate	date	None.
TerminationDate	date	None.
EthnicCode	EthnicCode	None.
TerminationReason	string	None.
FWTFilingStatusCodeOrDefault	string	None.
FullOrPartTime	FullOrPartTime	None.
CustomFields	Collection of DynamicFieldValueDTO	None.
EmergencyContacts	Collection of AMSEmergencyContactDTO	None.
PayrollInfo	AMSPayrollInfoDTO	None.
DivisionKey	GlobalEntityKeyOfIDivision	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
CompanyCode	string	None.
DivisionCode	string	None.
ExternalKey	string	None.
EmployeeNumber	string	None.
Status	EmployeeStatus	None.
FirstName	string	None.
MiddleInitial	string	None.
LastName	string	None.
Email	string	None.
HomePhone	string	None.
HireDate	date	None.
SyncStatus	AMSSyncStatus	None.
ComparisonStatus	AMSComparisonStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ssn": "sample string 1",
  "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"
  },
  "workPhone": "sample string 2",
  "mobilePhone": "sample string 3",
  "fax": "sample string 4",
  "gender": "Male",
  "jobTitle": "sample string 5",
  "rehireDate": "0001-02-03",
  "birthDate": "0001-02-03",
  "terminationDate": "0001-02-03",
  "ethnicCode": "Declined",
  "terminationReason": "sample string 6",
  "fwtFilingStatusCodeOrDefault": "sample string 7",
  "fullOrPartTime": "FullTime",
  "customFields": [
    {
      "code": "sample string 1",
      "value": {}
    },
    {
      "code": "sample string 1",
      "value": {}
    }
  ],
  "emergencyContacts": [
    {
      "firstName": "sample string 1",
      "middleInitial": "sample string 2",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "workPhone": "sample string 5",
      "cellPhone": "sample string 6",
      "relationship": "sample string 7",
      "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"
      }
    },
    {
      "firstName": "sample string 1",
      "middleInitial": "sample string 2",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "workPhone": "sample string 5",
      "cellPhone": "sample string 6",
      "relationship": "sample string 7",
      "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"
      }
    }
  ],
  "payrollInfo": {
    "baseRate": 1.0,
    "payCycle": "YEAR",
    "employmentType": "W2",
    "costCenter1": "sample string 2",
    "costCenter2": "sample string 3",
    "costCenter3": "sample string 4",
    "costCenter4": "sample string 5",
    "costCenter5": "sample string 6",
    "defaultTaxLocation": "sample string 7",
    "swtFilingStatus": "sample string 8",
    "swtExemptions": 9,
    "fwtFilingStatus": "M",
    "fwtExemptions": 10,
    "uses2020W4Format": true,
    "dependentCredit": 12.0,
    "otherIncome": 13.0,
    "deductions": 14.0,
    "extraWithholdings": 15.0,
    "multipleJobs": true,
    "exemptFromOvertime": true
  },
  "divisionKey": "<empty>",
  "employeeKey": "<empty>",
  "companyCode": "sample string 8",
  "divisionCode": "sample string 9",
  "externalKey": "sample string 10",
  "employeeNumber": "sample string 11",
  "status": "Active",
  "firstName": "sample string 12",
  "middleInitial": "sample string 13",
  "lastName": "sample string 14",
  "email": "sample string 15",
  "homePhone": "sample string 16",
  "hireDate": "0001-02-03",
  "syncStatus": "None",
  "comparisonStatus": "None"
}

text/xml

Sample:

<AMSEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <CompanyCode>sample string 8</CompanyCode>
  <ComparisonStatus>None</ComparisonStatus>
  <DivisionCode>sample string 9</DivisionCode>
  <DivisionKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </DivisionKey>
  <Email>sample string 15</Email>
  <EmployeeKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </EmployeeKey>
  <EmployeeNumber>sample string 11</EmployeeNumber>
  <ExternalKey>sample string 10</ExternalKey>
  <FirstName>sample string 12</FirstName>
  <HireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
  </HireDate>
  <HomePhone>sample string 16</HomePhone>
  <LastName>sample string 14</LastName>
  <MiddleInitial>sample string 13</MiddleInitial>
  <Status>Active</Status>
  <SyncStatus>None</SyncStatus>
  <Address>
    <Address1>sample string 1</Address1>
    <Address2>sample string 2</Address2>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <County>sample string 7</County>
    <State>sample string 4</State>
    <Zip>sample string 5</Zip>
  </Address>
  <BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
  </BirthDate>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.DTO.Models">
    <d2p1:DynamicFieldValueDTO>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Value />
    </d2p1:DynamicFieldValueDTO>
    <d2p1:DynamicFieldValueDTO>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Value />
    </d2p1:DynamicFieldValueDTO>
  </CustomFields>
  <EmergencyContacts>
    <AMSEmergencyContactDTO>
      <Address>
        <Address1>sample string 1</Address1>
        <Address2>sample string 2</Address2>
        <City>sample string 3</City>
        <Country>sample string 6</Country>
        <County>sample string 7</County>
        <State>sample string 4</State>
        <Zip>sample string 5</Zip>
      </Address>
      <CellPhone>sample string 6</CellPhone>
      <FirstName>sample string 1</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>sample string 2</MiddleInitial>
      <Relationship>sample string 7</Relationship>
      <WorkPhone>sample string 5</WorkPhone>
    </AMSEmergencyContactDTO>
    <AMSEmergencyContactDTO>
      <Address>
        <Address1>sample string 1</Address1>
        <Address2>sample string 2</Address2>
        <City>sample string 3</City>
        <Country>sample string 6</Country>
        <County>sample string 7</County>
        <State>sample string 4</State>
        <Zip>sample string 5</Zip>
      </Address>
      <CellPhone>sample string 6</CellPhone>
      <FirstName>sample string 1</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>sample string 2</MiddleInitial>
      <Relationship>sample string 7</Relationship>
      <WorkPhone>sample string 5</WorkPhone>
    </AMSEmergencyContactDTO>
  </EmergencyContacts>
  <EthnicCode>Declined</EthnicCode>
  <FWTFilingStatusCodeOrDefault>sample string 7</FWTFilingStatusCodeOrDefault>
  <Fax>sample string 4</Fax>
  <FullOrPartTime>FullTime</FullOrPartTime>
  <Gender>Male</Gender>
  <JobTitle>sample string 5</JobTitle>
  <MobilePhone>sample string 3</MobilePhone>
  <PayrollInfo>
    <BaseRate>1</BaseRate>
    <CostCenter1>sample string 2</CostCenter1>
    <CostCenter2>sample string 3</CostCenter2>
    <CostCenter3>sample string 4</CostCenter3>
    <CostCenter4>sample string 5</CostCenter4>
    <CostCenter5>sample string 6</CostCenter5>
    <Deductions>14</Deductions>
    <DefaultTaxLocation>sample string 7</DefaultTaxLocation>
    <DependentCredit>12</DependentCredit>
    <EmploymentType>W2</EmploymentType>
    <ExemptFromOvertime>true</ExemptFromOvertime>
    <ExtraWithholdings>15</ExtraWithholdings>
    <FwtExemptions>10</FwtExemptions>
    <FwtFilingStatus>M</FwtFilingStatus>
    <MultipleJobs>true</MultipleJobs>
    <OtherIncome>13</OtherIncome>
    <PayCycle>YEAR</PayCycle>
    <SwtExemptions>9</SwtExemptions>
    <SwtFilingStatus>sample string 8</SwtFilingStatus>
    <Uses2020W4Format>true</Uses2020W4Format>
  </PayrollInfo>
  <RehireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
  </RehireDate>
  <SSN>sample string 1</SSN>
  <TerminationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
  </TerminationDate>
  <TerminationReason>sample string 6</TerminationReason>
  <WorkPhone>sample string 2</WorkPhone>
</AMSEmployeeDTO>