POST api/Deal/GetDeals?DealershipID={DealershipID}

Get list of all Deals with Deal information

Request Information

URI Parameters

Name	Description	Type	Additional information
DealershipID		integer	Required

Body Parameters

DealFilter

Name	Type	Additional information
DateRangeFrom	date	None.
DateRangeTo	date	None.
DateRange	string	None.
DealTypeID	DealTypeFilterEnum	None.
DealStatusID	DealStatusFilterEnum	None.
Customer	string	None.
TempTag	string	None.
BuyerID	integer	None.
LienHolderID	integer	None.
EmployeeID	integer	None.
LeadSourceID	integer	None.
SoldAtID	integer	None.
SignerID	integer	None.
PageSize	PageSizeEnum	None.
Discount	string	None.
HasInternalDealAccess	boolean	None.
NonZeroBalance	boolean	None.
AftermarketTypeID	AfterMarketProductTypeEnum	None.
ModelYear	integer	None.
MakeID	integer	None.
ModelID	integer	None.
BodyStyleID	integer	None.
StockNumber	string	None.
VIN	string	None.
VehicleID	integer	None.
HaveTitle	TitleStatusEnum	None.
HasAftermarket	boolStatusEnum	None.
HasTradeIn	boolStatusEnum	None.
TitleStatusID	enumVehicleTitleStatusType	None.
IsWholeSaleDeal	boolean	None.
IsOutofStateDeal	boolean	None.
IsPaid	boolean	None.
IsReturned	boolean	None.
PublishStatus	VehiclePublishStatusEnum	None.
VehicleLocationID	integer	None.
PurchaseDate	date	None.
PurchaseFromID	integer	None.
TitleStatusStepID	VehicleTitleListEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "DateRangeFrom": "2025-05-11T10:46:55.2948408-04:00",
  "DateRangeTo": "2025-05-11T10:46:55.2948408-04:00",
  "DateRange": "sample string 1",
  "DealTypeID": 1,
  "DealStatusID": 0,
  "Customer": "sample string 2",
  "TempTag": "sample string 3",
  "BuyerID": 1,
  "LienHolderID": 1,
  "EmployeeID": 1,
  "LeadSourceID": 1,
  "SoldAtID": 1,
  "SignerID": 1,
  "PageSize": 10,
  "Discount": "sample string 4",
  "HasInternalDealAccess": true,
  "NonZeroBalance": true,
  "AftermarketTypeID": 1,
  "ModelYear": 1,
  "MakeID": 1,
  "ModelID": 1,
  "BodyStyleID": 1,
  "StockNumber": "sample string 6",
  "VIN": "sample string 7",
  "VehicleID": 1,
  "HaveTitle": 0,
  "HasAftermarket": 0,
  "HasTradeIn": 0,
  "TitleStatusID": 0,
  "IsWholeSaleDeal": true,
  "IsOutofStateDeal": true,
  "IsPaid": true,
  "IsReturned": true,
  "PublishStatus": 0,
  "VehicleLocationID": 1,
  "PurchaseDate": "2025-05-11T10:46:55.2948408-04:00",
  "PurchaseFromID": 1,
  "TitleStatusStepID": 0
}

application/xml, text/xml

Sample:

<DealFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DC.Core.Model">
  <BodyStyleID>1</BodyStyleID>
  <HasAftermarket>Yes</HasAftermarket>
  <HasTradeIn>Yes</HasTradeIn>
  <HaveTitle>With_No_Title</HaveTitle>
  <IsOutofStateDeal>true</IsOutofStateDeal>
  <IsPaid>true</IsPaid>
  <IsReturned>true</IsReturned>
  <IsWholeSaleDeal>true</IsWholeSaleDeal>
  <MakeID>1</MakeID>
  <ModelID>1</ModelID>
  <ModelYear>1</ModelYear>
  <PublishStatus>Not_Published</PublishStatus>
  <PurchaseDate>2025-05-11T10:46:55.2948408-04:00</PurchaseDate>
  <PurchaseFromID>1</PurchaseFromID>
  <StockNumber>sample string 6</StockNumber>
  <TitleStatusID>Clean</TitleStatusID>
  <TitleStatusStepID>Not_Set</TitleStatusStepID>
  <VIN>sample string 7</VIN>
  <VehicleID>1</VehicleID>
  <VehicleLocationID>1</VehicleLocationID>
  <AftermarketTypeID>ServiceContract</AftermarketTypeID>
  <BuyerID>1</BuyerID>
  <Customer>sample string 2</Customer>
  <DateRange>sample string 1</DateRange>
  <DateRangeFrom>2025-05-11T10:46:55.2948408-04:00</DateRangeFrom>
  <DateRangeTo>2025-05-11T10:46:55.2948408-04:00</DateRangeTo>
  <DealStatusID>All_Active_Deal</DealStatusID>
  <DealTypeID>Cash</DealTypeID>
  <Discount>sample string 4</Discount>
  <EmployeeID>1</EmployeeID>
  <HasInternalDealAccess>true</HasInternalDealAccess>
  <LeadSourceID>1</LeadSourceID>
  <LienHolderID>1</LienHolderID>
  <NonZeroBalance>true</NonZeroBalance>
  <PageSize>P10</PageSize>
  <SignerID>1</SignerID>
  <SoldAtID>1</SoldAtID>
  <TempTag>sample string 3</TempTag>
</DealFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DealListingDTO

Name	Type	Additional information
DealID	integer	None.
DealDate	date	None.
DealDateText	string	None.
Customer	string	None.
VehicleID	integer	None.
VIN	string	None.
StockNumber	string	None.
ModelYear	integer	None.
Make	string	None.
Model	string	None.
Color	string	None.
SalePrice	decimal number	None.
TypeOfDeal	DealTypeEnum	None.
TypeOfDealText	string	None.
DealStatusID	DealStatusEnum	None.
DealStatusIDText	string	None.
SaleTotal	decimal number	None.
BalanceDue	decimal number	None.
SellerName	string	None.
TradeAmount	decimal number	None.
AMPrice	decimal number	None.
Mileage	integer	None.
LeadSourceName	string	None.
TrackingURL	string	None.
LienHolderName	string	None.
ContractTypeDescription	string	None.
ContractType	byte	None.
ApplyCode	boolean	None.
ColorCode	string	None.
PhoneNumber	string	None.
ApplyColor	boolean	None.
ApplyCodeSoldAt	boolean	None.
ColorCodeSoldAt	string	None.
ApplyColorSoldAt	boolean	None.
NoContract	boolean	None.
NoTracking	boolean	None.
Working	boolean	None.
Prospect	boolean	None.
AMClass	string	None.
VTRClass	string	None.
VSCClass	string	None.
TradeClass	string	None.
CoBuyerID	integer	None.
CoBuyerName	string	None.
PaymentModeID	enumPaymentType	None.
PaymentModeText	string	None.
BankName	string	None.
DeliveryDate	date	None.
Age	integer	None.
IsFutureDeal	boolean	None.
EmailAddress	string	None.
PhoneNumber2	string	None.
Street	string	None.
ZIPCode	string	None.
City	string	None.
State	string	None.
FirstName	string	None.
LastName	string	None.
Phone2	string	None.
SecondSellerName	string	None.
SignerName	string	None.
DealAge	integer	None.
StateFeeTax	string	None.
VTRPrice	decimal number	None.
VSCPrice	decimal number	None.
PNoteAmount	decimal number	None.
PNoteDueDate	date	None.
PNoteDueDateText	string	None.
LastFundedDateAdd	date	None.
LastFundedDateAddText	string	None.
TotalCost	decimal number	None.
PackFee	decimal number	None.
TotalCostPlusPackFee	decimal number	None.
VGP	decimal number	None.
TotalTax	decimal number	None.
TotalDealFee	decimal number	None.
CommissionPaid	decimal number	None.
VGP2	decimal number	None.
NetPL	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DealID": 1,
    "DealDate": "2025-05-11T10:46:55.3260915-04:00",
    "DealDateText": "5/11/2025",
    "Customer": "sample string 3",
    "VehicleID": 1,
    "VIN": "sample string 4",
    "StockNumber": "sample string 5",
    "ModelYear": 1,
    "Make": "sample string 6",
    "Model": "sample string 7",
    "Color": "sample string 8",
    "SalePrice": 9.0,
    "TypeOfDeal": 1,
    "TypeOfDealText": "Cash",
    "DealStatusID": 1,
    "DealStatusIDText": "Prospect",
    "SaleTotal": 10.0,
    "BalanceDue": 11.0,
    "SellerName": "sample string 12",
    "TradeAmount": 13.0,
    "AMPrice": 14.0,
    "Mileage": 1,
    "LeadSourceName": "sample string 15",
    "TrackingURL": "sample string 16",
    "LienHolderName": "sample string 17",
    "ContractTypeDescription": "sample string 18",
    "ContractType": 64,
    "ApplyCode": true,
    "ColorCode": "sample string 20",
    "PhoneNumber": "sample string 21",
    "ApplyColor": true,
    "ApplyCodeSoldAt": true,
    "ColorCodeSoldAt": "sample string 23",
    "ApplyColorSoldAt": true,
    "NoContract": false,
    "NoTracking": false,
    "Working": false,
    "Prospect": true,
    "AMClass": "Green",
    "VTRClass": "VTR",
    "VSCClass": "VSC",
    "TradeClass": "Blue",
    "CoBuyerID": 1,
    "CoBuyerName": "sample string 24",
    "PaymentModeID": 1,
    "PaymentModeText": "FloorPlan",
    "BankName": "sample string 25",
    "DeliveryDate": "2025-05-11T10:46:55.3260915-04:00",
    "Age": 1,
    "IsFutureDeal": false,
    "EmailAddress": "sample string 26",
    "PhoneNumber2": "sample string 27",
    "Street": "sample string 28",
    "ZIPCode": "sample string 29",
    "City": "sample string 30",
    "State": "sample string 31",
    "FirstName": "sample string 32",
    "LastName": "sample string 33",
    "Phone2": "sample string 27",
    "SecondSellerName": "sample string 34",
    "SignerName": "sample string 35",
    "DealAge": 1,
    "StateFeeTax": "sample string 36",
    "VTRPrice": 37.0,
    "VSCPrice": 38.0,
    "PNoteAmount": 39.0,
    "PNoteDueDate": "2025-05-11T10:46:55.3417192-04:00",
    "PNoteDueDateText": "5/11/2025",
    "LastFundedDateAdd": "2025-05-11T10:46:55.3417192-04:00",
    "LastFundedDateAddText": "5/11/2025",
    "TotalCost": 40.0,
    "PackFee": 41.0,
    "TotalCostPlusPackFee": 81.0,
    "VGP": 42.0,
    "TotalTax": 43.0,
    "TotalDealFee": 44.0,
    "CommissionPaid": 45.0,
    "VGP2": 46.0,
    "NetPL": -40.0
  },
  {
    "DealID": 1,
    "DealDate": "2025-05-11T10:46:55.3260915-04:00",
    "DealDateText": "5/11/2025",
    "Customer": "sample string 3",
    "VehicleID": 1,
    "VIN": "sample string 4",
    "StockNumber": "sample string 5",
    "ModelYear": 1,
    "Make": "sample string 6",
    "Model": "sample string 7",
    "Color": "sample string 8",
    "SalePrice": 9.0,
    "TypeOfDeal": 1,
    "TypeOfDealText": "Cash",
    "DealStatusID": 1,
    "DealStatusIDText": "Prospect",
    "SaleTotal": 10.0,
    "BalanceDue": 11.0,
    "SellerName": "sample string 12",
    "TradeAmount": 13.0,
    "AMPrice": 14.0,
    "Mileage": 1,
    "LeadSourceName": "sample string 15",
    "TrackingURL": "sample string 16",
    "LienHolderName": "sample string 17",
    "ContractTypeDescription": "sample string 18",
    "ContractType": 64,
    "ApplyCode": true,
    "ColorCode": "sample string 20",
    "PhoneNumber": "sample string 21",
    "ApplyColor": true,
    "ApplyCodeSoldAt": true,
    "ColorCodeSoldAt": "sample string 23",
    "ApplyColorSoldAt": true,
    "NoContract": false,
    "NoTracking": false,
    "Working": false,
    "Prospect": true,
    "AMClass": "Green",
    "VTRClass": "VTR",
    "VSCClass": "VSC",
    "TradeClass": "Blue",
    "CoBuyerID": 1,
    "CoBuyerName": "sample string 24",
    "PaymentModeID": 1,
    "PaymentModeText": "FloorPlan",
    "BankName": "sample string 25",
    "DeliveryDate": "2025-05-11T10:46:55.3260915-04:00",
    "Age": 1,
    "IsFutureDeal": false,
    "EmailAddress": "sample string 26",
    "PhoneNumber2": "sample string 27",
    "Street": "sample string 28",
    "ZIPCode": "sample string 29",
    "City": "sample string 30",
    "State": "sample string 31",
    "FirstName": "sample string 32",
    "LastName": "sample string 33",
    "Phone2": "sample string 27",
    "SecondSellerName": "sample string 34",
    "SignerName": "sample string 35",
    "DealAge": 1,
    "StateFeeTax": "sample string 36",
    "VTRPrice": 37.0,
    "VSCPrice": 38.0,
    "PNoteAmount": 39.0,
    "PNoteDueDate": "2025-05-11T10:46:55.3417192-04:00",
    "PNoteDueDateText": "5/11/2025",
    "LastFundedDateAdd": "2025-05-11T10:46:55.3417192-04:00",
    "LastFundedDateAddText": "5/11/2025",
    "TotalCost": 40.0,
    "PackFee": 41.0,
    "TotalCostPlusPackFee": 81.0,
    "VGP": 42.0,
    "TotalTax": 43.0,
    "TotalDealFee": 44.0,
    "CommissionPaid": 45.0,
    "VGP2": 46.0,
    "NetPL": -40.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfDealListingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DC.Core.Model">
  <DealListingDTO>
    <AMPrice>14</AMPrice>
    <Age>1</Age>
    <ApplyCode>true</ApplyCode>
    <ApplyCodeSoldAt>true</ApplyCodeSoldAt>
    <BalanceDue>11</BalanceDue>
    <BankName>sample string 25</BankName>
    <City>sample string 30</City>
    <CoBuyerID>1</CoBuyerID>
    <CoBuyerName>sample string 24</CoBuyerName>
    <Color>sample string 8</Color>
    <ColorCode>sample string 20</ColorCode>
    <ColorCodeSoldAt>sample string 23</ColorCodeSoldAt>
    <CommissionPaid>45</CommissionPaid>
    <ContractType>64</ContractType>
    <ContractTypeDescription>sample string 18</ContractTypeDescription>
    <Customer>sample string 3</Customer>
    <DealAge>1</DealAge>
    <DealDate>2025-05-11T10:46:55.3260915-04:00</DealDate>
    <DealID>1</DealID>
    <DealStatusID>Prospect</DealStatusID>
    <DeliveryDate>2025-05-11T10:46:55.3260915-04:00</DeliveryDate>
    <EmailAddress>sample string 26</EmailAddress>
    <FirstName>sample string 32</FirstName>
    <LastFundedDateAdd>2025-05-11T10:46:55.3417192-04:00</LastFundedDateAdd>
    <LastName>sample string 33</LastName>
    <LeadSourceName>sample string 15</LeadSourceName>
    <LienHolderName>sample string 17</LienHolderName>
    <Make>sample string 6</Make>
    <Mileage>1</Mileage>
    <Model>sample string 7</Model>
    <ModelYear>1</ModelYear>
    <PNoteAmount>39</PNoteAmount>
    <PNoteDueDate>2025-05-11T10:46:55.3417192-04:00</PNoteDueDate>
    <PackFee>41</PackFee>
    <PaymentModeID>FloorPlan</PaymentModeID>
    <PhoneNumber>sample string 21</PhoneNumber>
    <PhoneNumber2>sample string 27</PhoneNumber2>
    <SalePrice>9</SalePrice>
    <SaleTotal>10</SaleTotal>
    <SecondSellerName>sample string 34</SecondSellerName>
    <SellerName>sample string 12</SellerName>
    <SignerName>sample string 35</SignerName>
    <State>sample string 31</State>
    <StateFeeTax>sample string 36</StateFeeTax>
    <StockNumber>sample string 5</StockNumber>
    <Street>sample string 28</Street>
    <TotalCost>40</TotalCost>
    <TotalDealFee>44</TotalDealFee>
    <TotalTax>43</TotalTax>
    <TrackingURL>sample string 16</TrackingURL>
    <TradeAmount>13</TradeAmount>
    <TypeOfDeal>Cash</TypeOfDeal>
    <VGP>42</VGP>
    <VGP2>46</VGP2>
    <VIN>sample string 4</VIN>
    <VSCPrice>38</VSCPrice>
    <VTRPrice>37</VTRPrice>
    <VehicleID>1</VehicleID>
    <ZIPCode>sample string 29</ZIPCode>
  </DealListingDTO>
  <DealListingDTO>
    <AMPrice>14</AMPrice>
    <Age>1</Age>
    <ApplyCode>true</ApplyCode>
    <ApplyCodeSoldAt>true</ApplyCodeSoldAt>
    <BalanceDue>11</BalanceDue>
    <BankName>sample string 25</BankName>
    <City>sample string 30</City>
    <CoBuyerID>1</CoBuyerID>
    <CoBuyerName>sample string 24</CoBuyerName>
    <Color>sample string 8</Color>
    <ColorCode>sample string 20</ColorCode>
    <ColorCodeSoldAt>sample string 23</ColorCodeSoldAt>
    <CommissionPaid>45</CommissionPaid>
    <ContractType>64</ContractType>
    <ContractTypeDescription>sample string 18</ContractTypeDescription>
    <Customer>sample string 3</Customer>
    <DealAge>1</DealAge>
    <DealDate>2025-05-11T10:46:55.3260915-04:00</DealDate>
    <DealID>1</DealID>
    <DealStatusID>Prospect</DealStatusID>
    <DeliveryDate>2025-05-11T10:46:55.3260915-04:00</DeliveryDate>
    <EmailAddress>sample string 26</EmailAddress>
    <FirstName>sample string 32</FirstName>
    <LastFundedDateAdd>2025-05-11T10:46:55.3417192-04:00</LastFundedDateAdd>
    <LastName>sample string 33</LastName>
    <LeadSourceName>sample string 15</LeadSourceName>
    <LienHolderName>sample string 17</LienHolderName>
    <Make>sample string 6</Make>
    <Mileage>1</Mileage>
    <Model>sample string 7</Model>
    <ModelYear>1</ModelYear>
    <PNoteAmount>39</PNoteAmount>
    <PNoteDueDate>2025-05-11T10:46:55.3417192-04:00</PNoteDueDate>
    <PackFee>41</PackFee>
    <PaymentModeID>FloorPlan</PaymentModeID>
    <PhoneNumber>sample string 21</PhoneNumber>
    <PhoneNumber2>sample string 27</PhoneNumber2>
    <SalePrice>9</SalePrice>
    <SaleTotal>10</SaleTotal>
    <SecondSellerName>sample string 34</SecondSellerName>
    <SellerName>sample string 12</SellerName>
    <SignerName>sample string 35</SignerName>
    <State>sample string 31</State>
    <StateFeeTax>sample string 36</StateFeeTax>
    <StockNumber>sample string 5</StockNumber>
    <Street>sample string 28</Street>
    <TotalCost>40</TotalCost>
    <TotalDealFee>44</TotalDealFee>
    <TotalTax>43</TotalTax>
    <TrackingURL>sample string 16</TrackingURL>
    <TradeAmount>13</TradeAmount>
    <TypeOfDeal>Cash</TypeOfDeal>
    <VGP>42</VGP>
    <VGP2>46</VGP2>
    <VIN>sample string 4</VIN>
    <VSCPrice>38</VSCPrice>
    <VTRPrice>37</VTRPrice>
    <VehicleID>1</VehicleID>
    <ZIPCode>sample string 29</ZIPCode>
  </DealListingDTO>
</ArrayOfDealListingDTO>