GET v1/export/clients/{clientCode}
Retrieve Specific Client
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ExportClientDTO| Name | Description | 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"
}
text/xml
Sample:
<ExportClientDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<ClientCode>sample string 1</ClientCode>
<ClientName>sample string 2</ClientName>
<Companies>
<ExportCompanyDTO>
<CompanyCode>sample string 3</CompanyCode>
<LegalName>sample string 4</LegalName>
<Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d4p1:Address1>sample string 1</d4p1:Address1>
<d4p1:Address2>sample string 2</d4p1:Address2>
<d4p1:City>sample string 3</d4p1:City>
<d4p1:Country>sample string 6</d4p1:Country>
<d4p1:County>sample string 7</d4p1:County>
<d4p1:State>sample string 4</d4p1:State>
<d4p1:Zip>sample string 5</d4p1:Zip>
</Address>
<EIN>sample string 1</EIN>
<SICCode>sample string 2</SICCode>
<StartDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d4p1:Year>1</d4p1:Year>
<d4p1:Month>2</d4p1:Month>
<d4p1:Day>3</d4p1:Day>
</StartDate>
<Divisions>
<ExportDivisionDTO>
<CompanyLegalName>sample string 2</CompanyLegalName>
<DivisionKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d6p1:CompanyCode>sample string 1</d6p1:CompanyCode>
<d6p1:DivisionCode>sample string 2</d6p1:DivisionCode>
</DivisionKey>
<DivisionName>sample string 3</DivisionName>
<DBA>sample string 1</DBA>
<DivisionId xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d6p1:_entityKey>
<d6p1:_hasValue>false</d6p1:_hasValue>
<d6p1:_value>00000000-0000-0000-0000-000000000000</d6p1:_value>
</d6p1:_entityKey>
</DivisionId>
<DivisionStatus>Active</DivisionStatus>
<TerminationDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d6p1:Year>1</d6p1:Year>
<d6p1:Month>2</d6p1:Month>
<d6p1:Day>3</d6p1:Day>
</TerminationDate>
</ExportDivisionDTO>
<ExportDivisionDTO>
<CompanyLegalName>sample string 2</CompanyLegalName>
<DivisionKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d6p1:CompanyCode>sample string 1</d6p1:CompanyCode>
<d6p1:DivisionCode>sample string 2</d6p1:DivisionCode>
</DivisionKey>
<DivisionName>sample string 3</DivisionName>
<DBA>sample string 1</DBA>
<DivisionId xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d6p1:_entityKey>
<d6p1:_hasValue>false</d6p1:_hasValue>
<d6p1:_value>00000000-0000-0000-0000-000000000000</d6p1:_value>
</d6p1:_entityKey>
</DivisionId>
<DivisionStatus>Active</DivisionStatus>
<TerminationDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d6p1:Year>1</d6p1:Year>
<d6p1:Month>2</d6p1:Month>
<d6p1:Day>3</d6p1:Day>
</TerminationDate>
</ExportDivisionDTO>
</Divisions>
</ExportCompanyDTO>
<ExportCompanyDTO>
<CompanyCode>sample string 3</CompanyCode>
<LegalName>sample string 4</LegalName>
<Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d4p1:Address1>sample string 1</d4p1:Address1>
<d4p1:Address2>sample string 2</d4p1:Address2>
<d4p1:City>sample string 3</d4p1:City>
<d4p1:Country>sample string 6</d4p1:Country>
<d4p1:County>sample string 7</d4p1:County>
<d4p1:State>sample string 4</d4p1:State>
<d4p1:Zip>sample string 5</d4p1:Zip>
</Address>
<EIN>sample string 1</EIN>
<SICCode>sample string 2</SICCode>
<StartDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d4p1:Year>1</d4p1:Year>
<d4p1:Month>2</d4p1:Month>
<d4p1:Day>3</d4p1:Day>
</StartDate>
<Divisions>
<ExportDivisionDTO>
<CompanyLegalName>sample string 2</CompanyLegalName>
<DivisionKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d6p1:CompanyCode>sample string 1</d6p1:CompanyCode>
<d6p1:DivisionCode>sample string 2</d6p1:DivisionCode>
</DivisionKey>
<DivisionName>sample string 3</DivisionName>
<DBA>sample string 1</DBA>
<DivisionId xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d6p1:_entityKey>
<d6p1:_hasValue>false</d6p1:_hasValue>
<d6p1:_value>00000000-0000-0000-0000-000000000000</d6p1:_value>
</d6p1:_entityKey>
</DivisionId>
<DivisionStatus>Active</DivisionStatus>
<TerminationDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d6p1:Year>1</d6p1:Year>
<d6p1:Month>2</d6p1:Month>
<d6p1:Day>3</d6p1:Day>
</TerminationDate>
</ExportDivisionDTO>
<ExportDivisionDTO>
<CompanyLegalName>sample string 2</CompanyLegalName>
<DivisionKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d6p1:CompanyCode>sample string 1</d6p1:CompanyCode>
<d6p1:DivisionCode>sample string 2</d6p1:DivisionCode>
</DivisionKey>
<DivisionName>sample string 3</DivisionName>
<DBA>sample string 1</DBA>
<DivisionId xmlns:d6p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d6p1:_entityKey>
<d6p1:_hasValue>false</d6p1:_hasValue>
<d6p1:_value>00000000-0000-0000-0000-000000000000</d6p1:_value>
</d6p1:_entityKey>
</DivisionId>
<DivisionStatus>Active</DivisionStatus>
<TerminationDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d6p1:Year>1</d6p1:Year>
<d6p1:Month>2</d6p1:Month>
<d6p1:Day>3</d6p1:Day>
</TerminationDate>
</ExportDivisionDTO>
</Divisions>
</ExportCompanyDTO>
</Companies>
</ExportClientDTO>