Skip to Content
Prets Developer Portal

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.

Attributes

  • quoteIdstring

    Unique identifier for the quote

  • opportunityobjectoptional

    Financing opportunity for this quote. Omitted while terms includes indicative.

    Show child attributes
  • merchantobjectoptional

    Merchant that issued this quote, from Quote__c Merchant_Account__r.

    Show child attributes
    • namestring

      Merchant display name

    • Platform merchant id (mer_{ULID})

    • slugstring

      Merchant organization slug

  • progressSummarystringoptional

    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
    • 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

    • When country is NL: Postal/ZIP code. Letter suffix is case-insensitive; Dutch-shaped values canonicalize to 1234 AB.

      When country is not NL: Postal/ZIP code

    • citystringoptional

      City/locality name

    • streetstringoptional

      Only when country is NL

      Street name (Dutch format)

    • houseNumberstringoptional

      Only when country is NL

      House number

    • houseNumberAdditionstringoptional

      Only when country is NL

      House number addition/suffix

    • municipalitystringoptional

      Only when country is NL

      Dutch municipality (gemeente). Distinct from city (woonplaats). Optional.

    • streetAddressstringoptional

      Only when country is not NL

      Street 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)

    • firstNamestringoptional

      First name / given name

    • lastNamestring

      Last name / family name

    • Phone number in E.164 format

  • Quote currency (currently EUR only)

    Possible values: EUR

  • termsarray of enumsoptional

    Quote terms and conditions. Include indicative on create for a non-binding offer.

    Possible values: subject_to_financing, indicative

  • expiresAtstring (date)optional

    Quote expiration date (ISO 8601 calendar date)

  • sentAtstring (date)optional

    Date the quote was sent to the customer (ISO 8601 calendar date)

  • Total quote amount including tax in EUR

  • totalExclTaxnumberoptional

    Total quote amount excluding tax in EUR

  • descriptionstringoptional

    Description of the quote

  • intakeNotestringoptional

    Merchant context for Prets at quote handover

  • installerobjectoptional

    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.

  • externalIdstringoptional

    External reference ID for merchant's system (quote level)

  • tagsarray of enumsoptional

    Tags describing customer context and support needs to help ops team provide appropriate service

    Possible values: smartphone_only, landline_only, less_digitally_skilled, financially_complex, moderately_complex_finances, prefers_phone_contact, prefers_email_contact

  • financingobject

    Financing journey state for this quote. Indicative quotes use status: orientation until 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

      • reasonenumnullableoptional

        Only when type is not none

        When type is on_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 as unknown.

        When type is canceled: 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, other

      • descriptionstringoptional

        Only when type is not none

        When type is on_hold: Free-text note explaining the hold, captured in Salesforce; suitable for display to the merchant.

        When type is canceled: 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

    • 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 status or subStatus.

  • 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

    • externalIdstringoptional

      External reference ID for merchant's system

    • When type is not subsidy: Total price including tax

      When type is subsidy: Subsidy amount as a negative reduction. Excluded from the gross Quote total; summing all line items yields the subsidy-deducted figure.

    • totalExclTaxnumberoptional

      Only when type is not subsidy

      Total price excluding tax

    • unitPricenumberoptional

      Only when type is not subsidy

      Unit price per item before quantity multiplication

    • productIdentifiersobjectoptional

      Product identification metadata for matching and verification

      Show child attributes
    • incentiveCodesarray of stringsoptional

      When type is not subsidy: Subsidy/incentive codes (e.g., ISDE in NL, BAFA in DE, MaPrimeRénov in FR)

      When type is subsidy: Incentive programme codes this subsidy covers; joins to the QuoteLineItems carrying the same codes

    • descriptionstringoptional

      Description of the line item

    • Only when type is battery

      Total battery energy capacity in watt-hours (Wh)

    • totalNameplatePowernumberoptional

      Only when type is battery

      Maximum continuous charge/discharge power in watts (W)

    • Line item ID

    • quantityintegeroptional

      Only when type is pv

      Number of solar panels

    • wpPerModuleintegeroptional

      Only when type is pv

      Watt-peak (Wp) rating per panel at STC conditions

    • azimuthnumberoptional

      Only when type is pv

      Compass direction in degrees (0°=N, 90°=E, 180°=S, 270°=W)

    • tiltnumberoptional

      Only when type is pv

      Inclination angle from horizontal in degrees (0°=flat, 90°=vertical)

    • heatTransferMediumenumoptional

      Only when type is heat_pump

      Heat 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_brine

    • Only when type is heat_pump

      System configuration: electric (monovalent) or hybrid (bivalent with backup heating)

      Possible values: electric, hybrid

    • nameplatePowernumberoptional

      Only when type is heat_pump, ev_charger

      When type is heat_pump: Rated heating/cooling power output in watts (W)

      When type is ev_charger: Rated charging power in watts (W)

    • kindenumoptional

      Only when type is central_heating_boiler

      Declared boiler class. A high-efficiency (HR) boiler is condensing.

      Possible values: condensing, low_temperature, standard

    • fuelenumoptional

      Only when type is central_heating_boiler

      Boiler fuel

      Possible values: gas, oil

    • surfaceAreanumberoptional

      Only when type is 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

      When type is wall_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 type is windows: Total window surface area in square meters (m²)

      When type is insulated_doors, insulated_frames, insulated_infill_panels: Surface area in square meters (m²)

    • rValuenumberoptional

      Only when type is wall_insulation, external_wall_insulation, cavity_wall_insulation, sloped_roof_insulation, flat_roof_insulation, floor_insulation, attic_floor_insulation, ground_insulation

      Thermal resistance (R-value) in m²K/W. Higher is better. SI declared layer resistance (Rd).

    • paneCountenumoptional

      Only when type is windows

      Number of panes in the glazing unit

      Possible values: single, double, triple, quadruple

    • performanceRatingenumoptional

      Only when type is windows

      Dutch HR glass performance rating (Hoog Rendement = High Efficiency)

      Possible values: HR, HR+, HR++, HR+++, HR++++

    • uValuenumberoptional

      Only when type is windows, insulated_doors, insulated_frames, insulated_infill_panels

      When type is windows: Thermal transmittance (U-value) in W/m²K - lower is better

      When type is insulated_doors, insulated_frames, insulated_infill_panels: Thermal transmittance (U-value) in W/m²K. Lower is better.

    • storageMediumenumoptional

      Only when type is heat_battery

      Thermal storage medium: water, thermochemical (TCM), or phase-change (PCM)

      Possible values: water, tcm, pcm

    • heatStorageCapacitynumberoptional

      Only when type is heat_battery

      Thermal storage capacity in watt-hours (Wh). Not electrical battery capacity.

    • storageVolumenumberoptional

      Only when type is heat_pump_water_heater, solar_water_heater

      Hot water storage volume in litres

    • heatSourceenumoptional

      Only when type is heat_pump_water_heater

      Air 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_air

    • collectorKindenumoptional

      Only when type is solar_water_heater

      Solar thermal collector kind

      Possible values: flat_plate, evacuated_tube

    • collectorApertureAreanumberoptional

      Only when type is solar_water_heater

      Collector aperture area in square meters (m²). Not insulated surface area.

    • Only when type is drain_water_heat_recovery, ventilation_heat_recovery

      When type is drain_water_heat_recovery: CSA B55.1 / DIN 94678 drain-water heat recovery effectiveness as a percent, not a 0–1 fraction.

      When type is ventilation_heat_recovery: EN 13141-7 ventilation heat recovery temperature ratio as a percent, not a 0–1 fraction.

    • configurationenumoptional

      Only when type is ventilation_heat_recovery

      Central or room-level (decentral) ventilation heat recovery

      Possible values: central, decentral

    • controlenumoptional

      Only when type is mechanical_ventilation

      Demand-control sensors. Omit when the control strategy is unspecified.

      Possible values: co2, humidity, occupancy, co2_humidity, co2_humidity_occupancy

    • phasesenumoptional

      Only when type is ev_charger

      Supply phases: single-phase or three-phase

      Possible values: single, three

    • outletenumoptional

      Only when type is ev_charger

      Socket (contactdoos) or tethered cable (vaste kabel)

      Possible values: socket, tethered

    • belongsToenumoptional

      Only when type is installation, other

      Must 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