POST api/Deal/SaveDeal?DealershipID={DealershipID}
Add/Update Deal
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DealershipID | integer |
Required |
Body Parameters
DealDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| DealInfo | Deal |
None. |
|
| DealershipFees | Collection of DealFee |
None. |
|
| StateFees | Collection of DealFee |
None. |
|
| DealAllFeesIncluded | Collection of DealFee |
None. |
|
| Taxes | Collection of Tax |
None. |
|
| AfterMarketProducts | Collection of AfterMarketProduct |
None. |
|
| TradeIns | Collection of TradeIn |
None. |
|
| PNotes | Collection of PNote |
None. |
|
| DealRebates | Collection of DealRebate |
None. |
|
| Discounts | Collection of Discount |
None. |
|
| _Reserve | Reserve |
None. |
|
| FinanceDetail | FinanceDetail |
None. |
|
| _Insurance | Insurance |
None. |
|
| _TempRegistration | TempRegistration |
None. |
|
| BHPHPaymentSchedules | Collection of BHPHPaymentSchedule |
None. |
|
| HasCobuyer | boolean |
None. |
|
| DealerOrAuctionID | integer |
None. |
|
| StockNumber | string |
None. |
|
| IsWorking | boolean |
None. |
|
| DealPayments | Collection of DealPayment |
None. |
|
| DownPayments | Collection of DownPaymentDTO |
None. |
|
| FinancePayments | Collection of FinancePaymentDTO |
None. |
|
| RefundPayments | Collection of RefundDTO |
None. |
Request Formats
application/json, text/json
Sample:
{
"DealInfo": {
"DealID": 1,
"BuyerID": 2,
"CoBuyerID": 1,
"DealDate": "2025-11-05T10:02:54.0684157-05:00",
"SalePrice": 4.0,
"SaleTotal": 5.0,
"LienHolderID": 1,
"VehicleID": 1,
"LastVehicleID": 1,
"DealStatusID": 1,
"LastDealStatusID": 1,
"TypeOfDeal": 1,
"DealershipID": 6,
"LeadSourceID": 1,
"SellerID": 1,
"SecondSellerID": 1,
"SignedByID": 1,
"BalanceDue": 1.0,
"OperatorID": 1,
"SoldAtID": 1,
"UserID": 7,
"StateFeeTax": "sample string 8",
"CreditApplicationID": 1,
"Announcements": "sample string 9",
"ThirdSellerID": 1,
"StateInspection": 1.0,
"StationInspection": 1.0,
"LastOperationDate": "2025-11-05T10:02:54.0684157-05:00",
"AlertMemo": "sample string 11",
"BuyBackVehicleID": 1,
"BuyBackDifference": 1.0,
"SoldAtID2": 1
},
"DealershipFees": [
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
}
],
"StateFees": [
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
}
],
"DealAllFeesIncluded": [
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealFeeID": 1,
"FeeCategoryID": 64,
"Description": "sample string 3",
"Amount": 4.0,
"DealID": 5,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
}
],
"Taxes": [
{
"DealTaxID": 1,
"TaxCategoryID": 64,
"Description": "sample string 3",
"Rate": 4.0,
"Amount": 5.0,
"TaxVariableID": 1,
"Fixed": true,
"RangeStart": 7.0,
"RangeEnd": 8.0,
"DealID": 9,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
},
{
"DealTaxID": 1,
"TaxCategoryID": 64,
"Description": "sample string 3",
"Rate": 4.0,
"Amount": 5.0,
"TaxVariableID": 1,
"Fixed": true,
"RangeStart": 7.0,
"RangeEnd": 8.0,
"DealID": 9,
"TransactionID": 1,
"OperatorID": 1,
"RecordState": 3,
"Included": true,
"SoldAtID": 1
}
],
"AfterMarketProducts": [
{
"AfterMarketProductID": 1,
"Price": 1.0,
"Cost": 2.0,
"BusinessID": 3,
"Code": "sample string 4",
"Description": "sample string 5",
"Mileage": 1,
"Term": "sample string 6",
"AfterMarketProductTypeID": 1,
"DealID": 7,
"AutoDebt": true,
"TransactionID": 1,
"OperatorID": 1,
"LenderPay": true,
"RecordState": 3,
"IsRemoved": true,
"IsVoid": true,
"VoidTransactionID": 1
},
{
"AfterMarketProductID": 1,
"Price": 1.0,
"Cost": 2.0,
"BusinessID": 3,
"Code": "sample string 4",
"Description": "sample string 5",
"Mileage": 1,
"Term": "sample string 6",
"AfterMarketProductTypeID": 1,
"DealID": 7,
"AutoDebt": true,
"TransactionID": 1,
"OperatorID": 1,
"LenderPay": true,
"RecordState": 3,
"IsRemoved": true,
"IsVoid": true,
"VoidTransactionID": 1
}
],
"TradeIns": [
{
"DealTradeInID": 1,
"TradeAmount": 2.0,
"ACV": 3.0,
"Payoff": 4.0,
"CashBack": 5.0,
"NetTrade": 6.0,
"VIN": "sample string 7",
"StockNumber": "sample string 8",
"VehicleID": 1,
"ExistingLienProviderID": 1,
"QuotedBy": "sample string 9",
"QuiteGoodUntil": "sample string 10",
"DealID": 11,
"TransactionID": 1,
"OperatorID": 1,
"Mileage": 1,
"TradeInModelYear": 1,
"TradeInMake": "sample string 12",
"TradeInModel": "sample string 13",
"TradeInTrim": "sample string 14",
"TradeInOdometer": 15,
"TradeInColor": "sample string 16",
"TradeInBodyStyle": "sample string 17",
"ExistingLienHolder": "sample string 18",
"ExistingLienHolderStreet": "sample string 19",
"ExistingLienHolderCity": "sample string 20",
"ExistingLienHolderState": "sample string 21",
"ExistingLienHolderZipCode": "sample string 22",
"HasCarFaxReport": true,
"OwnerNo": 1,
"CfxUserID": "sample string 24",
"CfxDisplayURL": "sample string 25",
"HasTradeInVehicle": true,
"RecordState": 3,
"IsRemoved": true,
"VIN2": "sample string 28"
},
{
"DealTradeInID": 1,
"TradeAmount": 2.0,
"ACV": 3.0,
"Payoff": 4.0,
"CashBack": 5.0,
"NetTrade": 6.0,
"VIN": "sample string 7",
"StockNumber": "sample string 8",
"VehicleID": 1,
"ExistingLienProviderID": 1,
"QuotedBy": "sample string 9",
"QuiteGoodUntil": "sample string 10",
"DealID": 11,
"TransactionID": 1,
"OperatorID": 1,
"Mileage": 1,
"TradeInModelYear": 1,
"TradeInMake": "sample string 12",
"TradeInModel": "sample string 13",
"TradeInTrim": "sample string 14",
"TradeInOdometer": 15,
"TradeInColor": "sample string 16",
"TradeInBodyStyle": "sample string 17",
"ExistingLienHolder": "sample string 18",
"ExistingLienHolderStreet": "sample string 19",
"ExistingLienHolderCity": "sample string 20",
"ExistingLienHolderState": "sample string 21",
"ExistingLienHolderZipCode": "sample string 22",
"HasCarFaxReport": true,
"OwnerNo": 1,
"CfxUserID": "sample string 24",
"CfxDisplayURL": "sample string 25",
"HasTradeInVehicle": true,
"RecordState": 3,
"IsRemoved": true,
"VIN2": "sample string 28"
}
],
"PNotes": [
{
"PNoteID": 1,
"PaymentDate": "2025-11-05T10:02:54.0684157-05:00",
"PNoteDate": "2025-11-05T10:02:54.0684157-05:00",
"Amount": 4.0,
"Memo": "sample string 5",
"DealID": 6,
"TransactionID": 1,
"IsRemoved": true,
"RecordState": 3,
"PNoteOperatorID": 1,
"PNoteOperationDate": "2025-11-05T10:02:54.0684157-05:00"
},
{
"PNoteID": 1,
"PaymentDate": "2025-11-05T10:02:54.0684157-05:00",
"PNoteDate": "2025-11-05T10:02:54.0684157-05:00",
"Amount": 4.0,
"Memo": "sample string 5",
"DealID": 6,
"TransactionID": 1,
"IsRemoved": true,
"RecordState": 3,
"PNoteOperatorID": 1,
"PNoteOperationDate": "2025-11-05T10:02:54.0684157-05:00"
}
],
"DealRebates": [
{
"RebateID": 1,
"RebateDate": "2025-11-05T10:02:54.0684157-05:00",
"RebateTypeID": 0,
"Amount": 3.0,
"Memo": "sample string 4",
"DealID": 5,
"IsRemoved": true
},
{
"RebateID": 1,
"RebateDate": "2025-11-05T10:02:54.0684157-05:00",
"RebateTypeID": 0,
"Amount": 3.0,
"Memo": "sample string 4",
"DealID": 5,
"IsRemoved": true
}
],
"Discounts": [
{
"DealDiscountID": 1,
"DealID": 2,
"DiscountTypeID": 1,
"Amount": 3.0,
"Memo": "sample string 4",
"RecordState": 3,
"IsRemoved": true
},
{
"DealDiscountID": 1,
"DealID": 2,
"DiscountTypeID": 1,
"Amount": 3.0,
"Memo": "sample string 4",
"RecordState": 3,
"IsRemoved": true
}
],
"_Reserve": {
"DealID": 1,
"FlatReserve": 1.0,
"BuyRate": 1.0,
"BuyAmount": 1.0,
"RetainRate": 1.0,
"RetainAmount": 1.0,
"RecordState": 3,
"IsPayLater": true
},
"FinanceDetail": {
"DealID": 1,
"APR": 2.0,
"NoOfPayments": 3,
"Frequency": 1,
"FirstPaymentDate": "2025-11-05T10:02:54.0684157-05:00",
"PaymentAmount": 5.0,
"FinanceCharge": 6.0,
"AmountFinanced": 7.0,
"TotalOfPaymentAmounts": 8.0,
"TotalSalePrice": 9.0,
"UseOfVehicle": 1,
"APR2": 1.0,
"PaymentAmount2": 1.0,
"LoanPrepaidFee": 1.0,
"DesiredPayment": 1.0,
"FinalPayment": 1.0
},
"_Insurance": {
"DealID": 1,
"CompanyID": 1,
"AgentID": 1,
"IsLossPayee": true,
"PolicyNo": "sample string 3",
"FromDate": "2025-11-05T10:02:54.0684157-05:00",
"ToDate": "2025-11-05T10:02:54.0684157-05:00",
"FireTheft": 1.0,
"Comprehensive": 1.0,
"Collusion": 1.0,
"AgentNo": "sample string 4",
"RecordState": 3
},
"_TempRegistration": {
"DealID": 1,
"Odometer": 1,
"StateInspection": "sample string 2",
"OdometerStatus": 1,
"IssueDate1stTag": "2025-11-05T10:02:54.0684157-05:00",
"TempTag1stNo": "sample string 3",
"TransferTagNo": "sample string 4",
"TempTag2ndNo": "sample string 5",
"IssueDate2ndTag": "2025-11-05T10:02:54.0684157-05:00",
"DeliveryDate": "2025-11-05T10:02:54.0684157-05:00",
"TitleApplicationType": true,
"RecordState": 3
},
"BHPHPaymentSchedules": [
{
"BHPHPaymentScheduleID": 1,
"PaymentNumber": 2,
"DueDate": "2025-11-05T10:02:54.0684157-05:00",
"Amount": 4.0,
"Principal": 1.0,
"Interest": 1.0,
"DealID": 5,
"TransactionID": 1,
"SalesTax": 6.0,
"Extended": true,
"BHPHPaymentScheduleExtendID": 1
},
{
"BHPHPaymentScheduleID": 1,
"PaymentNumber": 2,
"DueDate": "2025-11-05T10:02:54.0684157-05:00",
"Amount": 4.0,
"Principal": 1.0,
"Interest": 1.0,
"DealID": 5,
"TransactionID": 1,
"SalesTax": 6.0,
"Extended": true,
"BHPHPaymentScheduleExtendID": 1
}
],
"HasCobuyer": true,
"DealerOrAuctionID": 2,
"StockNumber": "sample string 3",
"IsWorking": false,
"DealPayments": [
{
"DealID": 1,
"DealPaymentTypeID": 1,
"TransactionTypeID": 9,
"TransactionDescription": "Down Payment",
"IsSwiped": true,
"PPTransactionID": 1,
"VantivTransactionID": 1,
"TCC": 64,
"TCCText": "Card Swiped",
"DealerReserve": 3.0,
"RestockingFee": 4.0,
"RefundOfficeCredit": true,
"IsLenderRefund": true,
"OrderID": "sample string 7",
"ReferenceID": "sample string 8",
"ResponseTime": "2025-11-05T10:02:54.0684157-05:00",
"IsApproved": true,
"IsVoid": true,
"BankID": 11,
"ApprovalNumber": "sample string 12",
"ProcessorName": "sample string 13",
"TransactionIDVantiv": "sample string 14",
"HostTransactionID": "sample string 15",
"Banks": [
{
"ItemID": 1,
"Description": "sample string 2"
},
{
"ItemID": 1,
"Description": "sample string 2"
}
],
"EverywareOrderId": "sample string 16",
"TransactionID": 17,
"PaymentDate": "2025-11-05T10:02:54.0684157-05:00",
"PaymentDateText": "11/05/25",
"Amount": 19.0,
"AdvanceTax": 20.0,
"PaymentTypeID2": 1,
"PaymentTypeID": 1,
"PreviousPaymentTypeID": 1,
"Memo": "sample string 21",
"CheckNo": 1,
"PrintLater": true,
"CardHolderName": "sample string 23",
"CardNumber": "sample string 24",
"ExpiryMonth": 64,
"ExpiryYear": 1,
"ConvenienceFee": 1.0,
"DebitCardTypeID": 1,
"RecordState": 3,
"IsRemoved": true,
"EnableLocationRestriction": true
},
{
"DealID": 1,
"DealPaymentTypeID": 1,
"TransactionTypeID": 9,
"TransactionDescription": "Down Payment",
"IsSwiped": true,
"PPTransactionID": 1,
"VantivTransactionID": 1,
"TCC": 64,
"TCCText": "Card Swiped",
"DealerReserve": 3.0,
"RestockingFee": 4.0,
"RefundOfficeCredit": true,
"IsLenderRefund": true,
"OrderID": "sample string 7",
"ReferenceID": "sample string 8",
"ResponseTime": "2025-11-05T10:02:54.0684157-05:00",
"IsApproved": true,
"IsVoid": true,
"BankID": 11,
"ApprovalNumber": "sample string 12",
"ProcessorName": "sample string 13",
"TransactionIDVantiv": "sample string 14",
"HostTransactionID": "sample string 15",
"Banks": [
{
"ItemID": 1,
"Description": "sample string 2"
},
{
"ItemID": 1,
"Description": "sample string 2"
}
],
"EverywareOrderId": "sample string 16",
"TransactionID": 17,
"PaymentDate": "2025-11-05T10:02:54.0684157-05:00",
"PaymentDateText": "11/05/25",
"Amount": 19.0,
"AdvanceTax": 20.0,
"PaymentTypeID2": 1,
"PaymentTypeID": 1,
"PreviousPaymentTypeID": 1,
"Memo": "sample string 21",
"CheckNo": 1,
"PrintLater": true,
"CardHolderName": "sample string 23",
"CardNumber": "sample string 24",
"ExpiryMonth": 64,
"ExpiryYear": 1,
"ConvenienceFee": 1.0,
"DebitCardTypeID": 1,
"RecordState": 3,
"IsRemoved": true,
"EnableLocationRestriction": true
}
],
"DownPayments": [
{
"_FinancialTransactionDTO": {
"_FinancialTransaction": {
"TransactionID": 17,
"TransactionTypeId": 9,
"TransactionDate": "2025-11-05T10:02:54.0684157-05:00",
"TransactionDateText": "11/05/2025",
"TransactionCode": null,
"Amount": 19.0,
"AdvanceTax": 0.0,
"Description": "sample string 3 Down Payment",
"PaymentModeID": 1,
"PreviousPaymentModeID": 1,
"PayModeID": 1,
"PaymentType": 1,
"PayeeID": 1,
"PayerID": 2,
"BankID": 11,
"Memo": "sample string 21",
"IsBatchPart": false,
"DealershipID": 0,
"OperatorID": 7,
"OperationDate": "2025-11-05T10:02:54.1777876-05:00",
"VehicleID": 1,
"BusinessName": null,
"SoldAtID": null,
"RefNo": null,
"VendorCreditApplied": null,
"IsCarketa": false
},
"_ACHDetail": {
"TransactionID": 0,
"IsAcPersonal": null,
"IsAcTypeChecking": null,
"AccountNumber": null,
"RoutingNumber": null,
"FirstName": null,
"LastName": null,
"PPTransactionID": null
},
"_CheckDetail": {
"TransactionID": 0,
"CheckNo": null,
"PrintDate": null,
"CheckID": null
},
"_DebitCardDetail": {
"TransactionID": 0,
"CardHolderName": null,
"CardNumber": null,
"ExpiryMonth": null,
"ExpiryYear": null,
"IsSwiped": false,
"PPTransactionID": null,
"VantivTransactionID": null,
"TCC": null,
"DebitCardTypeID": null,
"ConvenienceFee": null
},
"_FloorPlanDetail": {
"TransactionID": 0,
"AppliedDate": "2025-11-05T10:02:54.1777876-05:00",
"PaidOffTransactionID": null,
"PaidOff": false
},
"_ConsignmentDetail": {
"TransactionID": 0,
"SuggestedSalePrice": 0.0,
"PaidOffTransactionID": null,
"IsPaidOff": false
},
"IsRemoved": false
},
"_DownPayment": {
"TransactionID": 17,
"IsApproved": false,
"DealID": 1,
"IsVoid": true,
"UpdateBalance": false,
"Amount": 0.0,
"IsRemoved": true,
"ConvenienceFee": null
}
},
{
"_FinancialTransactionDTO": {
"_FinancialTransaction": {
"TransactionID": 17,
"TransactionTypeId": 9,
"TransactionDate": "2025-11-05T10:02:54.0684157-05:00",
"TransactionDateText": "11/05/2025",
"TransactionCode": null,
"Amount": 19.0,
"AdvanceTax": 0.0,
"Description": "sample string 3 Down Payment",
"PaymentModeID": 1,
"PreviousPaymentModeID": 1,
"PayModeID": 1,
"PaymentType": 1,
"PayeeID": 1,
"PayerID": 2,
"BankID": 11,
"Memo": "sample string 21",
"IsBatchPart": false,
"DealershipID": 0,
"OperatorID": 7,
"OperationDate": "2025-11-05T10:02:54.1777876-05:00",
"VehicleID": 1,
"BusinessName": null,
"SoldAtID": null,
"RefNo": null,
"VendorCreditApplied": null,
"IsCarketa": false
},
"_ACHDetail": {
"TransactionID": 0,
"IsAcPersonal": null,
"IsAcTypeChecking": null,
"AccountNumber": null,
"RoutingNumber": null,
"FirstName": null,
"LastName": null,
"PPTransactionID": null
},
"_CheckDetail": {
"TransactionID": 0,
"CheckNo": null,
"PrintDate": null,
"CheckID": null
},
"_DebitCardDetail": {
"TransactionID": 0,
"CardHolderName": null,
"CardNumber": null,
"ExpiryMonth": null,
"ExpiryYear": null,
"IsSwiped": false,
"PPTransactionID": null,
"VantivTransactionID": null,
"TCC": null,
"DebitCardTypeID": null,
"ConvenienceFee": null
},
"_FloorPlanDetail": {
"TransactionID": 0,
"AppliedDate": "2025-11-05T10:02:54.1777876-05:00",
"PaidOffTransactionID": null,
"PaidOff": false
},
"_ConsignmentDetail": {
"TransactionID": 0,
"SuggestedSalePrice": 0.0,
"PaidOffTransactionID": null,
"IsPaidOff": false
},
"IsRemoved": false
},
"_DownPayment": {
"TransactionID": 17,
"IsApproved": false,
"DealID": 1,
"IsVoid": true,
"UpdateBalance": false,
"Amount": 0.0,
"IsRemoved": true,
"ConvenienceFee": null
}
}
],
"FinancePayments": [],
"RefundPayments": []
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.