The Quote object
Every field on a quote, as the API returns it.
A quote is your priced offer to a consumer for a home upgrade: its line items (products, installation work and declared subsidies), the totals including and excluding tax, and the consumer and address it is for. Creating a quote hands the sale to Prets, and financing reports where the consumer's financing journey stands. A quote can later be replaced by a newer revision that supersedes it. List quotes returns the same object without lineItems. More context: Quote amounts and Indicative quotes.
Events
Prets sends these events when a quote changes. Receive them with an event destination.
- quote.createdA new Quote was created. The quote may not yet have a financing decision.
- quote.updatedA Quote field changed in a way that does not match a more specific lifecycle event.
- quote.supersededA Quote was replaced by a newer revision; the previous quote is no longer billable.
- quote.financing.updatedThe Quote financing status or sub-status changed without reaching a more specific lifecycle event.
- quote.financing.offer_receivedA lender returned a financing offer for the Quote.
- quote.financing.completedFinancing has been completed and disbursed for the Quote.
- quote.financing.rejectedThe lender rejected financing for the Quote.
- quote.financing.canceledThe customer canceled financing for the Quote, or declined the offer.
Attributes
- quoteIdstring
Unique identifier for the quote
Financing opportunity for this quote. Omitted while
termsincludesindicative.Show child attributes
- opportunityIdstring
Salesforce opportunity this quote belongs to
Merchant that issued this quote, from Quote__c Merchant_Account__r.
Show child attributes
- namestring
Merchant display name
- merchantIdstring
Platform merchant id (
mer_{ULID}) - slugstring
Merchant organization slug
Merchant-safe rolling progress summary from the Opportunity (status, next step, owner). Omitted when empty or withheld. ListQuotes includes it only with expand=progressSummary.
- createdAtstring (date-time)
ISO 8601 timestamp when the quote was created
- updatedAtstring (date-time)
ISO 8601 timestamp when the quote was last updated
- addressobject
Installation address (Dutch or international format based on country)
Show child attributes
- countryenum
Show 250 possible values
NL,AD,AE,AF,AG,AI,AL,AM,AO,AQ,AR,AS,AT,AU,AW,AX,AZ,BA,BB,BD,BE,BF,BG,BH,BI,BJ,BL,BM,BN,BO,BQ,BR,BS,BT,BV,BW,BY,BZ,CA,CC,CD,CF,CG,CH,CI,CK,CL,CM,CN,CO,CR,CU,CV,CW,CX,CY,CZ,DE,DJ,DK,DM,DO,DZ,EC,EE,EG,EH,ER,ES,ET,FI,FJ,FK,FM,FO,FR,GA,GB,GD,GE,GF,GG,GH,GI,GL,GM,GN,GP,GQ,GR,GS,GT,GU,GW,GY,HK,HM,HN,HR,HT,HU,ID,IE,IL,IM,IN,IO,IQ,IR,IS,IT,JE,JM,JO,JP,KE,KG,KH,KI,KM,KN,KP,KR,KW,KY,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,LY,MA,MC,MD,ME,MF,MG,MH,MK,ML,MM,MN,MO,MP,MQ,MR,MS,MT,MU,MV,MW,MX,MY,MZ,NA,NC,NE,NF,NG,NI,NO,NP,NR,NU,NZ,OM,PA,PE,PF,PG,PH,PK,PL,PM,PN,PR,PS,PT,PW,PY,QA,RE,RO,RS,RU,RW,SA,SB,SC,SD,SE,SG,SH,SI,SJ,SK,SL,SM,SN,SO,SR,SS,ST,SV,SX,SY,SZ,TC,TD,TF,TG,TH,TJ,TK,TL,TM,TN,TO,TR,TT,TV,TW,TZ,UA,UG,UM,US,UY,UZ,VA,VC,VE,VG,VI,VN,VU,WF,WS,YE,YT,ZA,ZM,ZW,XK - postalCodestring
When
countryisNL: Postal/ZIP code. Letter suffix is case-insensitive; Dutch-shaped values canonicalize to1234 AB.When
countryis notNL: Postal/ZIP code City/locality name
Only when
countryisNLStreet name (Dutch format)
Only when
countryisNLHouse number
Only when
countryisNLHouse number addition/suffix
Only when
countryisNLDutch municipality (gemeente). Distinct from city (woonplaats). Optional.
Only when
countryis notNLStreet address (single line; include any sub-address like apt/floor inline)
- contactobject
Contact payload without server-assigned id (e.g. quote create/update body)
Show child attributes
- emailstring
Contact email address (normalized: trimmed, lowercased)
First name / given name
- lastNamestring
Last name / family name
- phoneNumberstring
Phone number in E.164 format
- currencyenum
Quote currency (currently EUR only)
Possible values:
EUR Quote terms and conditions. Include
indicativeon create for a non-binding offer.Possible values:
subject_to_financing,indicativeQuote expiration date (ISO 8601 calendar date)
Date the quote was sent to the customer (ISO 8601 calendar date)
- totalInclTaxnumber
Total quote amount including tax in EUR
Total quote amount excluding tax in EUR
Description of the quote
Merchant context for Prets at quote handover
The installer the submitting merchant expects to do this job. Not necessarily the only contender, and not the merchant on this quote. Omitted when unknown.
Show child attributes
- namestring
Name of the installer the submitting merchant expects to do this job, for example the one that already quoted it.
External reference ID for merchant's system (quote level)
- financingobject
Financing journey state for this quote. Indicative quotes use
status: orientationuntil an Opportunity is linked; presented quotes follow the main journey.Show child attributes
- phaseenum
Coarse financing list bucket derived from journey status
Possible values:
new,engaged,in_progress,completed,canceled - statusenum
Fine journey step of the consumer financing process from the merchant perspective
Show 16 possible values
orientation,new_customer,engaged,clearance_pending,application_started,documents_required,under_review,additional_documents_required,offer_received,financing_review,invoice_pending,completed,financing_rejected,canceled_by_consumer,offer_canceled,no_contact - subStatusobject
Overlay orthogonal to journey
status(ops pause or cancellation reason); always present.Show child attributes
- typeenum
Possible values:
none,on_hold,canceled Only when
typeis notnoneWhen
typeison_hold: Named hold reason, present only on older holds. New holds omit it; the reason is explained on a Case instead. Unrecognized values are returned asunknown.When
typeiscanceled: Reason a terminal canceled financing ended the way it did. Open enum; default-branch on unknown values.Show 18 possible values
customer_unreachable,quote_under_consideration,customer_personal_reason,customer_evaluating_independently,cancellation_requested,awaiting_documents,customer_no_show_unreachable,customer_no_show_voicemail,customer_no_show_rescheduled,installation_blocked,general_question,unknown,no_contact,declined_support,dropped_pre_offer,offer_declined,lender_rejected,otherOnly when
typeis notnoneWhen
typeison_hold: Free-text note explaining the hold, captured in Salesforce; suitable for display to the merchant.When
typeiscanceled: Free-text detail explaining the cancellation, captured in Salesforce; suitable for display to the merchant.
- methodarray of enums
Funding sources that completed the financing. Sources stack, so more than one may be present. Empty until classified; only meaningful when
status === completed.Possible values:
loan,own_funds,subsidy - waitingOnenum
Party that must act next on the headline financing path
Possible values:
none,consumer,lender,merchant,prets - statusChangedAtstring (date-time)
ISO 8601 timestamp of the last change to
statusorsubStatus.
- lineItemsarray of objects
Line items for the quote
Show child attributes
- typeenum
Show 26 possible values
battery,pv,heat_pump,central_heating_boiler,wall_insulation,external_wall_insulation,cavity_wall_insulation,sloped_roof_insulation,flat_roof_insulation,floor_insulation,attic_floor_insulation,ground_insulation,windows,insulated_doors,insulated_frames,insulated_infill_panels,heat_battery,heat_pump_water_heater,solar_water_heater,drain_water_heat_recovery,ventilation_heat_recovery,mechanical_ventilation,ev_charger,installation,other,subsidy External reference ID for merchant's system
- totalInclTaxnumber
When
typeis notsubsidy: Total price including taxWhen
typeissubsidy: Subsidy amount as a negative reduction. Excluded from the gross Quote total; summing all line items yields the subsidy-deducted figure. Only when
typeis notsubsidyTotal price excluding tax
Only when
typeis notsubsidyUnit price per item before quantity multiplication
Product identification metadata for matching and verification
Show child attributes
Product manufacturer or brand name
Manufacturer Part Number (MPN)
Global Trade Item Number (GTIN/EAN/UPC barcode)
When
typeis notsubsidy: Subsidy/incentive codes (e.g., ISDE in NL, BAFA in DE, MaPrimeRénov in FR)When
typeissubsidy: Incentive programme codes this subsidy covers; joins to the QuoteLineItems carrying the same codesDescription of the line item
Only when
typeisbatteryTotal battery energy capacity in watt-hours (Wh)
Only when
typeisbatteryMaximum continuous charge/discharge power in watts (W)
- lineItemIdstring
Line item ID
Only when
typeispvNumber of solar panels
Only when
typeispvWatt-peak (Wp) rating per panel at STC conditions
Only when
typeispvCompass direction in degrees (0°=N, 90°=E, 180°=S, 270°=W)
Only when
typeispvInclination angle from horizontal in degrees (0°=flat, 90°=vertical)
Only when
typeisheat_pumpHeat transfer medium per EN 14511 (source_to_sink). Brine = ground-source/geothermal.
Possible values:
air_to_air,air_to_water,air_to_brine,water_to_air,water_to_water,water_to_brine,brine_to_air,brine_to_water,brine_to_brineOnly when
typeisheat_pumpSystem configuration: electric (monovalent) or hybrid (bivalent with backup heating)
Possible values:
electric,hybridOnly when
typeisheat_pump,ev_chargerWhen
typeisheat_pump: Rated heating/cooling power output in watts (W)When
typeisev_charger: Rated charging power in watts (W)Only when
typeiscentral_heating_boilerDeclared boiler class. A high-efficiency (HR) boiler is condensing.
Possible values:
condensing,low_temperature,standardOnly when
typeiscentral_heating_boilerBoiler fuel
Possible values:
gas,oilOnly when
typeiswall_insulation,external_wall_insulation,cavity_wall_insulation,sloped_roof_insulation,flat_roof_insulation,floor_insulation,attic_floor_insulation,ground_insulation,windows,insulated_doors,insulated_frames,insulated_infill_panelsWhen
typeiswall_insulation,external_wall_insulation,cavity_wall_insulation,sloped_roof_insulation,flat_roof_insulation,floor_insulation,attic_floor_insulation,ground_insulation: Insulated surface area in square meters (m²)When
typeiswindows: Total window surface area in square meters (m²)When
typeisinsulated_doors,insulated_frames,insulated_infill_panels: Surface area in square meters (m²)Only when
typeiswall_insulation,external_wall_insulation,cavity_wall_insulation,sloped_roof_insulation,flat_roof_insulation,floor_insulation,attic_floor_insulation,ground_insulationThermal resistance (R-value) in m²K/W. Higher is better. SI declared layer resistance (Rd).
Only when
typeiswindowsNumber of panes in the glazing unit
Possible values:
single,double,triple,quadrupleOnly when
typeiswindowsDutch HR glass performance rating (Hoog Rendement = High Efficiency)
Possible values:
HR,HR+,HR++,HR+++,HR++++Only when
typeiswindows,insulated_doors,insulated_frames,insulated_infill_panelsWhen
typeiswindows: Thermal transmittance (U-value) in W/m²K - lower is betterWhen
typeisinsulated_doors,insulated_frames,insulated_infill_panels: Thermal transmittance (U-value) in W/m²K. Lower is better.Only when
typeisheat_batteryThermal storage medium: water, thermochemical (TCM), or phase-change (PCM)
Possible values:
water,tcm,pcmOnly when
typeisheat_batteryThermal storage capacity in watt-hours (Wh). Not electrical battery capacity.
Only when
typeisheat_pump_water_heater,solar_water_heaterHot water storage volume in litres
Only when
typeisheat_pump_water_heaterAir source for a domestic hot water heat pump (EN 16147). Exhaust air is ventilatielucht, not indoor air. Not a space-heating heat transfer medium.
Possible values:
indoor_air,non_heated_space_air,outdoor_air,exhaust_airOnly when
typeissolar_water_heaterSolar thermal collector kind
Possible values:
flat_plate,evacuated_tubeOnly when
typeissolar_water_heaterCollector aperture area in square meters (m²). Not insulated surface area.
Only when
typeisdrain_water_heat_recovery,ventilation_heat_recoveryWhen
typeisdrain_water_heat_recovery: CSA B55.1 / DIN 94678 drain-water heat recovery effectiveness as a percent, not a 0–1 fraction.When
typeisventilation_heat_recovery: EN 13141-7 ventilation heat recovery temperature ratio as a percent, not a 0–1 fraction.Only when
typeisventilation_heat_recoveryCentral or room-level (decentral) ventilation heat recovery
Possible values:
central,decentralOnly when
typeismechanical_ventilationDemand-control sensors. Omit when the control strategy is unspecified.
Possible values:
co2,humidity,occupancy,co2_humidity,co2_humidity_occupancyOnly when
typeisev_chargerSupply phases: single-phase or three-phase
Possible values:
single,threeOnly when
typeisev_chargerSocket (contactdoos) or tethered cable (vaste kabel)
Possible values:
socket,tetheredOnly when
typeisinstallation,otherMust differ from this line's own type. A sibling line of that type is not required.
Show 24 possible values
battery,pv,heat_pump,central_heating_boiler,wall_insulation,external_wall_insulation,cavity_wall_insulation,sloped_roof_insulation,flat_roof_insulation,floor_insulation,attic_floor_insulation,ground_insulation,windows,insulated_doors,insulated_frames,insulated_infill_panels,heat_battery,heat_pump_water_heater,solar_water_heater,drain_water_heat_recovery,ventilation_heat_recovery,mechanical_ventilation,ev_charger,installation