GET v1/Customers/{customerID}/CustomerDetailSummary
Get a detail summary of information about a customer (for 3rd party devs)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerID |
Id of the customer |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Customer detail summary
CustomerDetailSummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityID |
Id of the entity |
integer |
None. |
| IsPerson |
Signifies whether entity is person |
integer |
None. |
| FirstName |
First name |
string |
None. |
| MiddleName |
Middle name |
string |
None. |
| LastName |
Last name |
string |
None. |
| DOB |
Date of birth |
date |
None. |
| MaritalStatusID |
Marital status id |
byte |
None. |
| MaritalStatus |
Marital status |
string |
None. |
| Gender |
Gender |
string |
None. |
| BusinessName |
Business name |
string |
None. |
| LocationID |
Location id |
integer |
None. |
| CustomerSourceID |
Customer source id |
integer |
None. |
| EntityStatus |
Entity status |
string |
None. |
| SourceDetail |
Source detail |
string |
None. |
| CustomerSTatus |
Customer status |
string |
None. |
| Prospect |
Prospect |
boolean |
None. |
| CustomerNo |
Customer No |
string |
None. |
| CustomerSince |
Customer since date |
date |
None. |
| AgentID |
Agent id |
integer |
None. |
| AgentName |
Agent name |
string |
None. |
| CSRID |
CSR id |
integer |
None. |
| CSRName |
CSR name |
string |
None. |
| Type |
Type |
string |
None. |
| PreferredLanguageCode |
Preferred language code |
integer |
None. |
| DisplayName |
Display name |
string |
None. |
| Salutation |
Salutation |
string |
None. |
| SSN |
SSN |
string |
None. |
| DriverLicenseNo |
Driver license no |
string |
None. |
| FEIN |
FEIN |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"EntityID": 1,
"IsPerson": 2,
"FirstName": "sample string 3",
"MiddleName": "sample string 4",
"LastName": "sample string 5",
"DOB": "2026-08-14T13:56:21.2514895+00:00",
"MaritalStatusID": 64,
"MaritalStatus": "sample string 6",
"Gender": "sample string 7",
"BusinessName": "sample string 8",
"LocationID": 9,
"CustomerSourceID": 1,
"EntityStatus": "sample string 10",
"SourceDetail": "sample string 11",
"CustomerSTatus": "sample string 12",
"Prospect": true,
"CustomerNo": "sample string 14",
"CustomerSince": "2026-08-14T13:56:21.2514895+00:00",
"AgentID": 1,
"AgentName": "sample string 16",
"CSRID": 1,
"CSRName": "sample string 17",
"Type": "sample string 18",
"PreferredLanguageCode": 1,
"DisplayName": "sample string 19",
"Salutation": "sample string 20",
"SSN": "sample string 21",
"DriverLicenseNo": "sample string 22",
"FEIN": "sample string 23"
}
application/xml, text/xml
Sample:
<CustomerDetailSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts"> <AgentID>1</AgentID> <AgentName>sample string 16</AgentName> <BusinessName>sample string 8</BusinessName> <CSRID>1</CSRID> <CSRName>sample string 17</CSRName> <CustomerNo>sample string 14</CustomerNo> <CustomerSTatus>sample string 12</CustomerSTatus> <CustomerSince>2026-08-14T13:56:21.2514895+00:00</CustomerSince> <CustomerSourceID>1</CustomerSourceID> <DOB>2026-08-14T13:56:21.2514895+00:00</DOB> <DisplayName>sample string 19</DisplayName> <DriverLicenseNo>sample string 22</DriverLicenseNo> <EntityID>1</EntityID> <EntityStatus>sample string 10</EntityStatus> <FEIN>sample string 23</FEIN> <FirstName>sample string 3</FirstName> <Gender>sample string 7</Gender> <IsPerson>2</IsPerson> <LastName>sample string 5</LastName> <LocationID>9</LocationID> <MaritalStatus>sample string 6</MaritalStatus> <MaritalStatusID>64</MaritalStatusID> <MiddleName>sample string 4</MiddleName> <PreferredLanguageCode>1</PreferredLanguageCode> <Prospect>true</Prospect> <SSN>sample string 21</SSN> <Salutation>sample string 20</Salutation> <SourceDetail>sample string 11</SourceDetail> <Type>sample string 18</Type> </CustomerDetailSummaryDTO>