GET v1/export/companies/byClient/{clientCode}

Retrieve Companies

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportCompanyDetailDTO

Name	Type	Additional information
DBAName	string	None.
TaxJurisdictions	Collection of ExportTaxJurisdictionInfoDTO	None.
Divisions	Collection of ExportDivisionDTO	None.
EIN	string	None.
Address	AddressDTO	None.
SICCode	string	None.
StartDate	date	None.
CompanyCode	string	None.
LegalName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "dbaName": "sample string 1",
    "taxJurisdictions": [
      {
        "taxJurisdictionCode": "sample string 1",
        "taxJurisdictionName": "sample string 2",
        "taxJurisdictionEIN": "sample string 3",
        "taxJurisdictionType": "FIT"
      },
      {
        "taxJurisdictionCode": "sample string 1",
        "taxJurisdictionName": "sample string 2",
        "taxJurisdictionEIN": "sample string 3",
        "taxJurisdictionType": "FIT"
      }
    ],
    "divisions": [
      {
        "divisionId": "<empty>",
        "dba": "sample string 1",
        "divisionStatus": "Active",
        "terminationDate": "0001-02-03",
        "divisionKey": {
          "companyCode": "sample string 1",
          "divisionCode": "sample string 2"
        },
        "companyLegalName": "sample string 2",
        "divisionName": "sample string 3"
      },
      {
        "divisionId": "<empty>",
        "dba": "sample string 1",
        "divisionStatus": "Active",
        "terminationDate": "0001-02-03",
        "divisionKey": {
          "companyCode": "sample string 1",
          "divisionCode": "sample string 2"
        },
        "companyLegalName": "sample string 2",
        "divisionName": "sample string 3"
      }
    ],
    "ein": "sample string 2",
    "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"
    },
    "sicCode": "sample string 3",
    "startDate": "0001-02-03",
    "companyCode": "sample string 4",
    "legalName": "sample string 5"
  },
  {
    "dbaName": "sample string 1",
    "taxJurisdictions": [
      {
        "taxJurisdictionCode": "sample string 1",
        "taxJurisdictionName": "sample string 2",
        "taxJurisdictionEIN": "sample string 3",
        "taxJurisdictionType": "FIT"
      },
      {
        "taxJurisdictionCode": "sample string 1",
        "taxJurisdictionName": "sample string 2",
        "taxJurisdictionEIN": "sample string 3",
        "taxJurisdictionType": "FIT"
      }
    ],
    "divisions": [
      {
        "divisionId": "<empty>",
        "dba": "sample string 1",
        "divisionStatus": "Active",
        "terminationDate": "0001-02-03",
        "divisionKey": {
          "companyCode": "sample string 1",
          "divisionCode": "sample string 2"
        },
        "companyLegalName": "sample string 2",
        "divisionName": "sample string 3"
      },
      {
        "divisionId": "<empty>",
        "dba": "sample string 1",
        "divisionStatus": "Active",
        "terminationDate": "0001-02-03",
        "divisionKey": {
          "companyCode": "sample string 1",
          "divisionCode": "sample string 2"
        },
        "companyLegalName": "sample string 2",
        "divisionName": "sample string 3"
      }
    ],
    "ein": "sample string 2",
    "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"
    },
    "sicCode": "sample string 3",
    "startDate": "0001-02-03",
    "companyCode": "sample string 4",
    "legalName": "sample string 5"
  }
]

text/xml

Sample:

<ArrayOfExportCompanyDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportCompanyDetailDTO>
    <CompanyCode>sample string 4</CompanyCode>
    <LegalName>sample string 5</LegalName>
    <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>
    <EIN>sample string 2</EIN>
    <SICCode>sample string 3</SICCode>
    <StartDate 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>
    </StartDate>
    <Divisions>
      <ExportDivisionDTO>
        <CompanyLegalName>sample string 2</CompanyLegalName>
        <DivisionKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:CompanyCode>sample string 1</d5p1:CompanyCode>
          <d5p1:DivisionCode>sample string 2</d5p1:DivisionCode>
        </DivisionKey>
        <DivisionName>sample string 3</DivisionName>
        <DBA>sample string 1</DBA>
        <DivisionId xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </DivisionId>
        <DivisionStatus>Active</DivisionStatus>
        <TerminationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </TerminationDate>
      </ExportDivisionDTO>
      <ExportDivisionDTO>
        <CompanyLegalName>sample string 2</CompanyLegalName>
        <DivisionKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:CompanyCode>sample string 1</d5p1:CompanyCode>
          <d5p1:DivisionCode>sample string 2</d5p1:DivisionCode>
        </DivisionKey>
        <DivisionName>sample string 3</DivisionName>
        <DBA>sample string 1</DBA>
        <DivisionId xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </DivisionId>
        <DivisionStatus>Active</DivisionStatus>
        <TerminationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </TerminationDate>
      </ExportDivisionDTO>
    </Divisions>
    <DBAName>sample string 1</DBAName>
    <TaxJurisdictions>
      <ExportTaxJurisdictionInfoDTO>
        <TaxJurisdictionCode>sample string 1</TaxJurisdictionCode>
        <TaxJurisdictionEIN>sample string 3</TaxJurisdictionEIN>
        <TaxJurisdictionName>sample string 2</TaxJurisdictionName>
        <TaxJurisdictionType>FIT</TaxJurisdictionType>
      </ExportTaxJurisdictionInfoDTO>
      <ExportTaxJurisdictionInfoDTO>
        <TaxJurisdictionCode>sample string 1</TaxJurisdictionCode>
        <TaxJurisdictionEIN>sample string 3</TaxJurisdictionEIN>
        <TaxJurisdictionName>sample string 2</TaxJurisdictionName>
        <TaxJurisdictionType>FIT</TaxJurisdictionType>
      </ExportTaxJurisdictionInfoDTO>
    </TaxJurisdictions>
  </ExportCompanyDetailDTO>
  <ExportCompanyDetailDTO>
    <CompanyCode>sample string 4</CompanyCode>
    <LegalName>sample string 5</LegalName>
    <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>
    <EIN>sample string 2</EIN>
    <SICCode>sample string 3</SICCode>
    <StartDate 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>
    </StartDate>
    <Divisions>
      <ExportDivisionDTO>
        <CompanyLegalName>sample string 2</CompanyLegalName>
        <DivisionKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:CompanyCode>sample string 1</d5p1:CompanyCode>
          <d5p1:DivisionCode>sample string 2</d5p1:DivisionCode>
        </DivisionKey>
        <DivisionName>sample string 3</DivisionName>
        <DBA>sample string 1</DBA>
        <DivisionId xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </DivisionId>
        <DivisionStatus>Active</DivisionStatus>
        <TerminationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </TerminationDate>
      </ExportDivisionDTO>
      <ExportDivisionDTO>
        <CompanyLegalName>sample string 2</CompanyLegalName>
        <DivisionKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:CompanyCode>sample string 1</d5p1:CompanyCode>
          <d5p1:DivisionCode>sample string 2</d5p1:DivisionCode>
        </DivisionKey>
        <DivisionName>sample string 3</DivisionName>
        <DBA>sample string 1</DBA>
        <DivisionId xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </DivisionId>
        <DivisionStatus>Active</DivisionStatus>
        <TerminationDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </TerminationDate>
      </ExportDivisionDTO>
    </Divisions>
    <DBAName>sample string 1</DBAName>
    <TaxJurisdictions>
      <ExportTaxJurisdictionInfoDTO>
        <TaxJurisdictionCode>sample string 1</TaxJurisdictionCode>
        <TaxJurisdictionEIN>sample string 3</TaxJurisdictionEIN>
        <TaxJurisdictionName>sample string 2</TaxJurisdictionName>
        <TaxJurisdictionType>FIT</TaxJurisdictionType>
      </ExportTaxJurisdictionInfoDTO>
      <ExportTaxJurisdictionInfoDTO>
        <TaxJurisdictionCode>sample string 1</TaxJurisdictionCode>
        <TaxJurisdictionEIN>sample string 3</TaxJurisdictionEIN>
        <TaxJurisdictionName>sample string 2</TaxJurisdictionName>
        <TaxJurisdictionType>FIT</TaxJurisdictionType>
      </ExportTaxJurisdictionInfoDTO>
    </TaxJurisdictions>
  </ExportCompanyDetailDTO>
</ArrayOfExportCompanyDetailDTO>