POST api/quotes/getFinanceBreakdown
Gets a quotation from quoteAPI
Request Information
URI Parameters
None.
Body Parameters
ERP.Api.Models.CustomerPortal.LoanQuotationName | Description | Type | Additional information |
---|---|---|---|
Id |
Quote id |
integer |
None. |
ApplicationId |
Application id |
integer |
None. |
Vehicle |
Vehicle the quote is calculated for |
ERP.Api.Models.CustomerPortal.Vehicle |
None. |
FinanceRequest |
Financial details |
ERP.Api.Models.CustomerPortal.QuoteFinanceRequest |
None. |
FinanceResponse |
Financial details returned back as a result of a quote calculation |
ERP.Api.Models.CustomerPortal.QuoteFinanceResponse |
None. |
DateReceived |
Date when the quote was calculated |
date |
None. |
IsSelected |
Set to true if the customer selected to proceed with the quote |
boolean |
None. |
manualLookUpOccured |
Set to true if the customer lookup a vehicle using a reg plate |
boolean |
None. |
showroomVisitOccured |
Set to true if the customer visited the showroom |
boolean |
None. |
showroomCarSelectionOccured |
Set to true if the customer selected a car from showroom |
boolean |
None. |
Request Formats
application/json, text/json
{ "id": 1, "applicationId": 2, "vehicle": { "isShowroomPicked": true, "isSuggested": true, "id": 1, "make": "sample string 2", "model": "sample string 3", "derivative": "sample string 4", "registration": "sample string 5", "dateOfRegistration": "2025-01-19", "vin": "sample string 6", "newcar": true, "mockcar": true, "engineSize": 9, "сO2Emissions": 10, "fuelType": "sample string 11", "transmission": "sample string 12", "doors": 13, "colour": "sample string 14", "mileage": 15, "price": 16.0, "fullPrice": 17.0, "errors": {}, "valuation": { "average": 1.0, "below": 2.0, "clean": 3.0, "retail": 4.0, "future": 5.0 }, "imageUrl": "https://crm.creditplus.finance/images/Cap/CapImage.asp?width=350&quality=60&CapID=1", "capDetails": { "id": 1, "code": "sample string 2" } }, "financeRequest": { "annualMileage": 1, "financeType": "HP", "term": 2, "loanAmount": 3.0, "deposit": { "cash": 1.0, "partExchange": { "isShowroomPicked": true, "isSuggested": true, "id": 1, "make": "sample string 2", "model": "sample string 3", "derivative": "sample string 4", "registration": "sample string 5", "dateOfRegistration": "2025-01-19", "vin": "sample string 6", "newcar": true, "mockcar": true, "engineSize": 9, "сO2Emissions": 10, "fuelType": "sample string 11", "transmission": "sample string 12", "doors": 13, "colour": "sample string 14", "mileage": 15, "price": 16.0, "fullPrice": 17.0, "errors": {}, "valuation": { "average": 1.0, "below": 2.0, "clean": 3.0, "retail": 4.0, "future": 5.0 }, "imageUrl": "https://crm.creditplus.finance/images/Cap/CapImage.asp?width=350&quality=60&CapID=1", "capDetails": { "id": 1, "code": "sample string 2" } }, "total": 17.0 }, "flatRatePercent": 1.1, "commissionLenderTiers": [ { "lenderId": 1, "tier": 2 }, { "lenderId": 1, "tier": 2 } ] }, "financeResponse": { "financeType": "HP", "loanAmount": 1.0, "monthlyPayment": 2.0, "flatRate": 3.1, "apr": 4.1, "fees": 5.0, "initialFees": 1.0, "completionFees": 1.0, "distributedFees": 1.0, "totalCreditCharge": 1.0, "interestPayable": 1.0, "balloon": 6.0, "deposit": 7.0, "term": 8, "totalAmountPayable": 9.0, "dealerCommissionGuide": { "sampleSize": 1, "rangeMin": 2.0, "rangeMax": 3.0, "mean": 4.0, "standardError": 5.0 }, "dealerCommission": 1.0, "errors": null }, "dateReceived": "2025-01-19", "isSelected": true, "manualLookUpOccured": true, "showroomVisitOccured": true, "showroomCarSelectionOccured": true }
application/xml
text/xml
application/x-www-form-urlencoded
Response Information
Resource Description
ERP.Api.Models.CustomerPortal.LoanQuotationName | Description | Type | Additional information |
---|---|---|---|
Id |
Quote id |
integer |
None. |
ApplicationId |
Application id |
integer |
None. |
Vehicle |
Vehicle the quote is calculated for |
ERP.Api.Models.CustomerPortal.Vehicle |
None. |
FinanceRequest |
Financial details |
ERP.Api.Models.CustomerPortal.QuoteFinanceRequest |
None. |
FinanceResponse |
Financial details returned back as a result of a quote calculation |
ERP.Api.Models.CustomerPortal.QuoteFinanceResponse |
None. |
DateReceived |
Date when the quote was calculated |
date |
None. |
IsSelected |
Set to true if the customer selected to proceed with the quote |
boolean |
None. |
manualLookUpOccured |
Set to true if the customer lookup a vehicle using a reg plate |
boolean |
None. |
showroomVisitOccured |
Set to true if the customer visited the showroom |
boolean |
None. |
showroomCarSelectionOccured |
Set to true if the customer selected a car from showroom |
boolean |
None. |
Response Formats
application/json, text/json
{ "id": 1, "applicationId": 2, "vehicle": { "isShowroomPicked": true, "isSuggested": true, "id": 1, "make": "sample string 2", "model": "sample string 3", "derivative": "sample string 4", "registration": "sample string 5", "dateOfRegistration": "2025-01-19", "vin": "sample string 6", "newcar": true, "mockcar": true, "engineSize": 9, "сO2Emissions": 10, "fuelType": "sample string 11", "transmission": "sample string 12", "doors": 13, "colour": "sample string 14", "mileage": 15, "price": 16.0, "fullPrice": 17.0, "errors": {}, "valuation": { "average": 1.0, "below": 2.0, "clean": 3.0, "retail": 4.0, "future": 5.0 }, "imageUrl": "https://crm.creditplus.finance/images/Cap/CapImage.asp?width=350&quality=60&CapID=1", "capDetails": { "id": 1, "code": "sample string 2" } }, "financeRequest": { "annualMileage": 1, "financeType": "HP", "term": 2, "loanAmount": 3.0, "deposit": { "cash": 1.0, "partExchange": { "isShowroomPicked": true, "isSuggested": true, "id": 1, "make": "sample string 2", "model": "sample string 3", "derivative": "sample string 4", "registration": "sample string 5", "dateOfRegistration": "2025-01-19", "vin": "sample string 6", "newcar": true, "mockcar": true, "engineSize": 9, "сO2Emissions": 10, "fuelType": "sample string 11", "transmission": "sample string 12", "doors": 13, "colour": "sample string 14", "mileage": 15, "price": 16.0, "fullPrice": 17.0, "errors": {}, "valuation": { "average": 1.0, "below": 2.0, "clean": 3.0, "retail": 4.0, "future": 5.0 }, "imageUrl": "https://crm.creditplus.finance/images/Cap/CapImage.asp?width=350&quality=60&CapID=1", "capDetails": { "id": 1, "code": "sample string 2" } }, "total": 17.0 }, "flatRatePercent": 1.1, "commissionLenderTiers": [ { "lenderId": 1, "tier": 2 }, { "lenderId": 1, "tier": 2 } ] }, "financeResponse": { "financeType": "HP", "loanAmount": 1.0, "monthlyPayment": 2.0, "flatRate": 3.1, "apr": 4.1, "fees": 5.0, "initialFees": 1.0, "completionFees": 1.0, "distributedFees": 1.0, "totalCreditCharge": 1.0, "interestPayable": 1.0, "balloon": 6.0, "deposit": 7.0, "term": 8, "totalAmountPayable": 9.0, "dealerCommissionGuide": { "sampleSize": 1, "rangeMin": 2.0, "rangeMax": 3.0, "mean": 4.0, "standardError": 5.0 }, "dealerCommission": 1.0, "errors": null }, "dateReceived": "2025-01-19", "isSelected": true, "manualLookUpOccured": true, "showroomVisitOccured": true, "showroomCarSelectionOccured": true }