POST DealSheet/get
Request Information
URI Parameters
None.
Body Parameters
DealSheetRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| entityId | globally unique identifier |
None. |
|
| trimId | integer |
None. |
|
| calculationType | integer |
None. |
|
| stockNo | string |
None. |
|
| showDirectAlert | boolean |
None. |
|
| token | globally unique identifier |
Required |
Request Formats
application/json, text/json
Sample:
{
"entityId": "175fcba8-a5a5-4a68-86e3-ae914464f27c",
"trimId": 1,
"calculationType": 1,
"stockNo": "sample string 2",
"showDirectAlert": true,
"token": "b9527ae4-f339-4eb3-ab18-088bb0c19df0"
}
application/xml, text/xml
Sample:
<DealSheetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.DealSheet"> <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">b9527ae4-f339-4eb3-ab18-088bb0c19df0</token> <calculationType>1</calculationType> <entityId>175fcba8-a5a5-4a68-86e3-ae914464f27c</entityId> <showDirectAlert>true</showDirectAlert> <stockNo>sample string 2</stockNo> <trimId>1</trimId> </DealSheetRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DealSheet| Name | Description | Type | Additional information |
|---|---|---|---|
| code | integer |
None. |
|
| error | string |
None. |
|
| Entity | EntityDetails |
None. |
|
| Activities | Collection of ActivityDetails |
None. |
|
| Service | Collection of ServiceDetails |
None. |
|
| Replacement | Replacement |
None. |
|
| Payments | Collection of Payment |
None. |
|
| APIVersion | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Entity": {
"DealerID": 1,
"Flagged": true,
"Sold": true,
"Owner": "sample string 4",
"Source": "sample string 5",
"FirstName": "sample string 6",
"MiddleName": "sample string 7",
"LastName": "sample string 8",
"CompanyName": "sample string 9",
"Address": "sample string 10",
"Address2": "sample string 11",
"City": "sample string 12",
"State": "sample string 13",
"ZipCode": "sample string 14",
"Color": "sample string 15",
"TradeValue": 1,
"EstCurrentMileage": 1,
"EstMilesPerMonth": 1,
"TotalMileageAllowed": 1,
"ProjectedMileage": 1,
"LeaseCurrentPenalty": 1,
"LeaseProjectedPenalty": 1,
"WarrantyMilesRemaining": 1,
"WarrantyMonthsRemaining": 1,
"SoldByName": "sample string 16",
"SaleTypeID": 1,
"Payment": 1,
"PmtMade": 1,
"PmtRemaining": 1,
"TermID": 1,
"SoldAsNew": true,
"HasExtWarranty": true,
"EstPayoff": 1,
"Equity": 1,
"BTM": 1,
"CreditConvertPaymentRangeMin": 1,
"CreditConvertPaymentRangeMax": 1,
"IsCreditConvert": true,
"RecentRODate": "2025-11-28T00:46:55.83543-08:00",
"ROApptDate": "2025-11-28T00:46:55.83543-08:00",
"RO18Months": 1,
"ExpirationDate": "2025-11-28T00:46:55.83543-08:00",
"HomePhone": "sample string 1",
"WorkPhone": "sample string 2",
"CellPhone": "sample string 3",
"Email": "sample string 4",
"StillOwn": true,
"VIN": "sample string 6",
"EntityID": "a5e8a626-e7a3-4177-a919-d055d8cbb19d",
"FullName": "sample string 7",
"TrimID": 1,
"IsAlert": true,
"IsFlexAlert": true,
"IsMileageAlert": true,
"IsWarrantyAlert": true,
"IsContractEnd": true,
"IsServiceAlert": true,
"IsServiceApptAlert": true,
"IsInMarketAlert": true,
"IsEngagedAlert": true,
"Kind": "sample string 8"
},
"Activities": [
{
"ActivityID": 1,
"ActivityActionID": 2,
"ActivityTypeID": 3,
"ActivityStatusID": 4,
"ActivityResultID": 1,
"SetByUserID": 5,
"AssignedToUserID": 1,
"SetDate": "2025-11-28T00:46:55.83543-08:00",
"DueDate": "2025-11-28T00:46:55.83543-08:00",
"Notes": "sample string 7",
"RecordingUrl": "sample string 8",
"ActivityActionSubTypeID": 64
},
{
"ActivityID": 1,
"ActivityActionID": 2,
"ActivityTypeID": 3,
"ActivityStatusID": 4,
"ActivityResultID": 1,
"SetByUserID": 5,
"AssignedToUserID": 1,
"SetDate": "2025-11-28T00:46:55.83543-08:00",
"DueDate": "2025-11-28T00:46:55.83543-08:00",
"Notes": "sample string 7",
"RecordingUrl": "sample string 8",
"ActivityActionSubTypeID": 64
}
],
"Service": [
{
"OpenDate": "2025-11-28T00:46:55.83543-08:00",
"Odometer": 2,
"ServiceAdvisor": "sample string 3"
},
{
"OpenDate": "2025-11-28T00:46:55.83543-08:00",
"Odometer": 2,
"ServiceAdvisor": "sample string 3"
}
],
"Replacement": {
"Mode": 0,
"Type": 0,
"Price": 1,
"AverageTrimID": 1,
"InventoryTrimID": 1,
"StockNo": "sample string 2",
"ShowUsed": true,
"ShowCPO": true
},
"Payments": [
{
"SaleTypeID": 1,
"TermID": 2,
"Rate": 3.1,
"Pmt": 4,
"Diff": 5,
"IsOverAllowance": true,
"IsAlert": true,
"IsFlexAlert": true
},
{
"SaleTypeID": 1,
"TermID": 2,
"Rate": 3.1,
"Pmt": 4,
"Diff": 5,
"IsOverAllowance": true,
"IsAlert": true,
"IsFlexAlert": true
}
],
"APIVersion": 1,
"code": 200,
"error": "sample string 1"
}
application/xml, text/xml
Sample:
<DealSheet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
<APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
<error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
<Activities>
<ActivityDetails>
<ActivityActionID>2</ActivityActionID>
<ActivityActionSubTypeID>64</ActivityActionSubTypeID>
<ActivityID>1</ActivityID>
<ActivityResultID>1</ActivityResultID>
<ActivityStatusID>4</ActivityStatusID>
<ActivityTypeID>3</ActivityTypeID>
<AssignedToUserID>1</AssignedToUserID>
<DueDate>2025-11-28T00:46:55.83543-08:00</DueDate>
<Notes>sample string 7</Notes>
<RecordingUrl>sample string 8</RecordingUrl>
<SetByUserID>5</SetByUserID>
<SetDate>2025-11-28T00:46:55.83543-08:00</SetDate>
</ActivityDetails>
<ActivityDetails>
<ActivityActionID>2</ActivityActionID>
<ActivityActionSubTypeID>64</ActivityActionSubTypeID>
<ActivityID>1</ActivityID>
<ActivityResultID>1</ActivityResultID>
<ActivityStatusID>4</ActivityStatusID>
<ActivityTypeID>3</ActivityTypeID>
<AssignedToUserID>1</AssignedToUserID>
<DueDate>2025-11-28T00:46:55.83543-08:00</DueDate>
<Notes>sample string 7</Notes>
<RecordingUrl>sample string 8</RecordingUrl>
<SetByUserID>5</SetByUserID>
<SetDate>2025-11-28T00:46:55.83543-08:00</SetDate>
</ActivityDetails>
</Activities>
<Entity>
<Kind>sample string 8</Kind>
<EntityID>a5e8a626-e7a3-4177-a919-d055d8cbb19d</EntityID>
<FullName>sample string 7</FullName>
<IsAlert>true</IsAlert>
<IsContractEnd>true</IsContractEnd>
<IsCreditConvert xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:boolean">true</IsCreditConvert>
<IsEngagedAlert>true</IsEngagedAlert>
<IsFlexAlert>true</IsFlexAlert>
<IsInMarketAlert>true</IsInMarketAlert>
<IsMileageAlert>true</IsMileageAlert>
<IsServiceAlert>true</IsServiceAlert>
<IsServiceApptAlert>true</IsServiceApptAlert>
<IsWarrantyAlert>true</IsWarrantyAlert>
<TrimID>1</TrimID>
<CellPhone>sample string 3</CellPhone>
<Email>sample string 4</Email>
<HomePhone>sample string 1</HomePhone>
<StillOwn>true</StillOwn>
<VIN>sample string 6</VIN>
<WorkPhone>sample string 2</WorkPhone>
<Address>sample string 10</Address>
<Address2>sample string 11</Address2>
<BTM>1</BTM>
<City>sample string 12</City>
<Color>sample string 15</Color>
<CompanyName>sample string 9</CompanyName>
<CreditConvertPaymentRangeMax>1</CreditConvertPaymentRangeMax>
<CreditConvertPaymentRangeMin>1</CreditConvertPaymentRangeMin>
<DealerID>1</DealerID>
<Equity>1</Equity>
<EstCurrentMileage>1</EstCurrentMileage>
<EstMilesPerMonth>1</EstMilesPerMonth>
<EstPayoff>1</EstPayoff>
<ExpirationDate>2025-11-28T00:46:55.83543-08:00</ExpirationDate>
<FirstName>sample string 6</FirstName>
<Flagged>true</Flagged>
<HasExtWarranty>true</HasExtWarranty>
<IsCreditConvert xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:boolean">true</IsCreditConvert>
<LastName>sample string 8</LastName>
<LeaseCurrentPenalty>1</LeaseCurrentPenalty>
<LeaseProjectedPenalty>1</LeaseProjectedPenalty>
<MiddleName>sample string 7</MiddleName>
<Owner>sample string 4</Owner>
<Payment>1</Payment>
<PmtMade>1</PmtMade>
<PmtRemaining>1</PmtRemaining>
<ProjectedMileage>1</ProjectedMileage>
<RO18Months>1</RO18Months>
<ROApptDate>2025-11-28T00:46:55.83543-08:00</ROApptDate>
<RecentRODate>2025-11-28T00:46:55.83543-08:00</RecentRODate>
<SaleTypeID>1</SaleTypeID>
<Sold>true</Sold>
<SoldAsNew>true</SoldAsNew>
<SoldByName>sample string 16</SoldByName>
<Source>sample string 5</Source>
<State>sample string 13</State>
<TermID>1</TermID>
<TotalMileageAllowed>1</TotalMileageAllowed>
<TradeValue>1</TradeValue>
<WarrantyMilesRemaining>1</WarrantyMilesRemaining>
<WarrantyMonthsRemaining>1</WarrantyMonthsRemaining>
<ZipCode>sample string 14</ZipCode>
</Entity>
<Payments>
<Payment>
<Diff>5</Diff>
<IsAlert>true</IsAlert>
<IsFlexAlert>true</IsFlexAlert>
<IsOverAllowance>true</IsOverAllowance>
<Pmt>4</Pmt>
<Rate>3.1</Rate>
<SaleTypeID>1</SaleTypeID>
<TermID>2</TermID>
</Payment>
<Payment>
<Diff>5</Diff>
<IsAlert>true</IsAlert>
<IsFlexAlert>true</IsFlexAlert>
<IsOverAllowance>true</IsOverAllowance>
<Pmt>4</Pmt>
<Rate>3.1</Rate>
<SaleTypeID>1</SaleTypeID>
<TermID>2</TermID>
</Payment>
</Payments>
<Replacement>
<AverageTrimID>1</AverageTrimID>
<InventoryTrimID>1</InventoryTrimID>
<Mode>Average</Mode>
<Price>1</Price>
<ShowCPO>true</ShowCPO>
<ShowUsed>true</ShowUsed>
<StockNo>sample string 2</StockNo>
<Type>New</Type>
</Replacement>
<Service>
<ServiceDetails>
<Odometer>2</Odometer>
<OpenDate>2025-11-28T00:46:55.83543-08:00</OpenDate>
<ServiceAdvisor>sample string 3</ServiceAdvisor>
</ServiceDetails>
<ServiceDetails>
<Odometer>2</Odometer>
<OpenDate>2025-11-28T00:46:55.83543-08:00</OpenDate>
<ServiceAdvisor>sample string 3</ServiceAdvisor>
</ServiceDetails>
</Service>
</DealSheet>