GET v1/export/clients

Retrieve Clients

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ExportClientDTO

Name	Type	Additional information
Companies	Collection of ExportCompanyDTO	None.
ClientCode	string	None.
ClientName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "companies": [
      {
        "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 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"
        },
        "sicCode": "sample string 2",
        "startDate": "0001-02-03",
        "companyCode": "sample string 3",
        "legalName": "sample string 4"
      },
      {
        "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 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"
        },
        "sicCode": "sample string 2",
        "startDate": "0001-02-03",
        "companyCode": "sample string 3",
        "legalName": "sample string 4"
      }
    ],
    "clientCode": "sample string 1",
    "clientName": "sample string 2"
  },
  {
    "companies": [
      {
        "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 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"
        },
        "sicCode": "sample string 2",
        "startDate": "0001-02-03",
        "companyCode": "sample string 3",
        "legalName": "sample string 4"
      },
      {
        "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 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"
        },
        "sicCode": "sample string 2",
        "startDate": "0001-02-03",
        "companyCode": "sample string 3",
        "legalName": "sample string 4"
      }
    ],
    "clientCode": "sample string 1",
    "clientName": "sample string 2"
  }
]

text/xml

Sample:

<ArrayOfExportClientDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportClientDTO>
    <ClientCode>sample string 1</ClientCode>
    <ClientName>sample string 2</ClientName>
    <Companies>
      <ExportCompanyDTO>
        <CompanyCode>sample string 3</CompanyCode>
        <LegalName>sample string 4</LegalName>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <EIN>sample string 1</EIN>
        <SICCode>sample string 2</SICCode>
        <StartDate 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>
        </StartDate>
        <Divisions>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
        </Divisions>
      </ExportCompanyDTO>
      <ExportCompanyDTO>
        <CompanyCode>sample string 3</CompanyCode>
        <LegalName>sample string 4</LegalName>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <EIN>sample string 1</EIN>
        <SICCode>sample string 2</SICCode>
        <StartDate 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>
        </StartDate>
        <Divisions>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
        </Divisions>
      </ExportCompanyDTO>
    </Companies>
  </ExportClientDTO>
  <ExportClientDTO>
    <ClientCode>sample string 1</ClientCode>
    <ClientName>sample string 2</ClientName>
    <Companies>
      <ExportCompanyDTO>
        <CompanyCode>sample string 3</CompanyCode>
        <LegalName>sample string 4</LegalName>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <EIN>sample string 1</EIN>
        <SICCode>sample string 2</SICCode>
        <StartDate 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>
        </StartDate>
        <Divisions>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
        </Divisions>
      </ExportCompanyDTO>
      <ExportCompanyDTO>
        <CompanyCode>sample string 3</CompanyCode>
        <LegalName>sample string 4</LegalName>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <EIN>sample string 1</EIN>
        <SICCode>sample string 2</SICCode>
        <StartDate 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>
        </StartDate>
        <Divisions>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
          <ExportDivisionDTO>
            <CompanyLegalName>sample string 2</CompanyLegalName>
            <DivisionKey xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
              <d7p1:CompanyCode>sample string 1</d7p1:CompanyCode>
              <d7p1:DivisionCode>sample string 2</d7p1:DivisionCode>
            </DivisionKey>
            <DivisionName>sample string 3</DivisionName>
            <DBA>sample string 1</DBA>
            <DivisionId xmlns:d7p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
              <d7p1:_entityKey>
                <d7p1:_hasValue>false</d7p1:_hasValue>
                <d7p1:_value>00000000-0000-0000-0000-000000000000</d7p1:_value>
              </d7p1:_entityKey>
            </DivisionId>
            <DivisionStatus>Active</DivisionStatus>
            <TerminationDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
              <d7p1:Year>1</d7p1:Year>
              <d7p1:Month>2</d7p1:Month>
              <d7p1:Day>3</d7p1:Day>
            </TerminationDate>
          </ExportDivisionDTO>
        </Divisions>
      </ExportCompanyDTO>
    </Companies>
  </ExportClientDTO>
</ArrayOfExportClientDTO>