API Changelog
Changes to the public Prets API, updated weekly.
Installer name on quotes, and a session link for indicative quotes.
🧾 Quotes
POST /v1/quotes,GET /v1/quotes, andGET /v1/quotes/{quoteId}: the expected installer is optionalinstaller.name. A request that still sendsexpectedInstallerdoes not store it. (Breaking)POST /v1/quoteswithsession=trueon an indicative quote returnslinks.session. That link opens the orientation page. It no longer responds 422. (Breaking)POST /v1/quotestreats a blankcontact.firstNameas omitted. (Additive)
Indicative quotes use a term instead of isIndicative.
🧾 Quotes
POST /v1/quotesno longer acceptsisIndicative. Send"terms": ["indicative"]for an indicative quote. (Breaking)- Quote responses include
indicativeintermswhile the quote is indicative;isIndicativeis gone. (Breaking) - A client still sending
isIndicative: truenow gets a presented quote. (Breaking) - Indicative creates still omit
opportunity, setfinancing.statustoorientation, and rejectsession=truewith 422.
Details: Create a quote, Indicative quotes.
CreateQuote supports unsigned quotes and indicative labelling.
🧾 Quotes
POST /v1/quotesaccepts optionalisIndicative. Omit it (or setfalse) for the default create:Presentedwith Opportunity, unchanged from before. SetisIndicative: trueonly for an indicative quote (Indicative, no Opportunity). (Additive)- Response
isIndicativeis derived fromStatus__c(Indicativevs other values). (Additive) - Unsigned indicative quotes omit
opportunitybut always includefinancingwithstatus: orientation. Presented quotes keep the existing journey. (Additive) session=truereturns 422 for unsigned creates because session links require an Opportunity. (Additive)
Details: Create a quote, Indicative quotes.
CreateQuote accepts more measure types and documents 422 errors.
🧾 Quotes
POST /v1/quotesaccepts named measure types (wall insulation, heat battery, boilers, ventilation, and more) plusev_charger,installation, andother. (Additive)otherandinstallationlines accept optionalbelongsTo.ev_chargeraccepts optionalnameplatePower,phases, andoutlet. (Additive)- CreateQuote documents the 422 validation envelope and intake-field errors. (Additive)
Cases API and case lifecycle events.
🎫 Cases
- Documented six Cases routes:
GET /v1/cases,POST /v1/quotes/{quoteId}/cases,GET /v1/cases/{caseId},GET/POST /v1/cases/{caseId}/messages, andPOST /v1/cases/{caseId}/close. (Additive) GET /v1/casesfilters:state(open/closed),quoteId,updatedSince, pluscursor/limit. Messages are a sub-resource, not embedded on Case. (Additive)
🔔 Events
- New webhooks:
case.created,case.updated,case.closed,case.message.replied. Thin payloads; refetchGET /v1/cases/{caseId}(and/messagesfor replies). (Additive)
Public quote list defaults to ListQuote; expand line items when you need them.
🧾 Quotes
GET /v1/quotesis now documented. Default items are ListQuote (Quote withoutlineItems). Passexpand=lineItemsfor Quote. GetQuote is unchanged. (Additive)- Unknown
expandvalues return 400parameter_invalidwithparam=expand. (Additive)
Optional municipality on Dutch quote addresses.
🧾 Quotes
POST /v1/quotesandGET /v1/quotes/{quoteId}: Dutchaddressobjects accept optionalmunicipality(gemeente), distinct from city. (Additive)
Optional intake note on create and get quote.
🧾 Quotes
POST /v1/quotesandGET /v1/quotes/{quoteId}: added optionalintakeNote— merchant context for Prets at quote handover. (Additive)
Subsidy line items, quote portal deeplinks, and more forgiving postal code validation.
🧾 Quotes
POST /v1/quotesandGET /v1/quotes/{quoteId}: added a newsubsidyline item type. It carries a negativetotalInclTax(a reduction applied to the quote total) and a requiredincentiveCodesarray, whose codes must match incentive codes declared on other QuoteLineItems. (Additive)POST /v1/quotesandGET /v1/quotes/{quoteId}: addedlinks.portalQuote, a deeplink to the quote in the merchant portal. Present only for organization API keys. (Additive)POST /v1/quotes: Dutch postal codes with a lowercase letter suffix (for example8101xp) are now accepted and normalized to the1234 ABformat. Requests that previously failed validation now succeed. (Additive)
A richer quote financing contract, a renamed financing webhook event, and a standardized error format.
🧾 Quotes
GET /v1/quotes/{quoteId}andPOST /v1/quotes: thefinancingobject is now always present and richer. Addedphase,method(array ofloan/own_funds/subsidy), andwaitingOn. (Breaking)financing.subStatusis now required and uses atypediscriminator withnone,on_hold, andcanceledarms (the previousextra_info_neededarm was removed). (Breaking)financing.statusvalues changed:financing_completed→completed, andcancelled_by_customerwas split intocanceled_by_consumerandoffer_canceled. Addedadditional_documents_requiredandinvoice_pending. (Breaking)- New
on_holdreasons:installation_blocked,general_question, andunknown. (Additive)
🔔 Events
- The
quote.financing.cancelledwebhook event was renamed toquote.financing.canceled. (Breaking)
⚠️ Errors
- All endpoints now return a standardized error envelope:
{ error: { type, code, message, param?, requestId } }. Themessagefield is unchanged;type,code,param, andrequestIdare new. (Additive)
Stricter validation for quote incentive codes and terms.
🧾 Quotes
POST /v1/quotes:lineItems[].incentiveCodesandtermsno longer accept values containing a semicolon (;). Requests that include a semicolon in these fields now fail validation. (Breaking)