Skip to Content
Prets Developer Portal

Get a quote

GET
/v1/quotes/{quoteId}

to try read requests with your account, or paste an API key into the Authorization field. Create an API key in the Partner Portal.

Retrieves a quote with its line items and current financing status. Use it to refresh a quote after a quote.* event, since events carry only the quote's ids. Pass expand=preferredScenario to include the consumer's preferred financing scenario.

Returns the quote. preferredScenario is present only when expanded, and is null when none is stored. Returns 404 when the quote does not exist or is not visible to you.

Path Parameters

quoteId*string

The unique identifier of the quote

Match^qot_[0-9A-HJKMNP-TV-Z]{26}$

Query Parameters

expand?|array<string>

Repeated field names to expand. Allowlisted: preferredScenario. Unknown names are invalid.

Response Body

The quote

application/json
  1. response

Quote retrieval response

data*|
links?

Authorization

bearerAuth
headerAuthorizationBearer <token>
Example Request
curl -X GET 'https://api.prets.app/v1/quotes/qot_01ARZ3NDEKTSV4RRFFQ69G5FAV'
Example Response
{  "data": {    "quoteId": "qot_01ARZ3NDEKTSV4RRFFQ69G5FAV",    "opportunity": {      "opportunityId": "opp_01ARZ3NDEKTSV4RRFFQ69G5FAV"    },    "merchant": {      "name": "Test merchant",      "merchantId": "mer_01ARZ3NDEKTSV4RRFFQ69G5FAV",      "slug": "test-merchant"    },    "progressSummary": "The financing application is under review at the lender. Prets will follow up when an offer is available.",    "createdAt": "2024-06-15T10:30:00.000Z",    "updatedAt": "2024-06-15T10:30:00.000Z",    "address": {      "country": "NL",      "postalCode": "1000 AA",      "city": "Amsterdam",      "street": "Kerkstraat",      "houseNumber": "42",      "houseNumberAddition": "A",      "municipality": "Amsterdam"    },    "contact": {      "email": "jan.jansen@example.nl",      "firstName": "Jan",      "lastName": "Jansen",      "phoneNumber": "+31612345678"    },    "currency": "EUR",    "terms": [      "subject_to_financing"    ],    "expiresAt": "2024-12-31",    "sentAt": "2024-06-15",    "totalInclTax": 25000,    "totalExclTax": 20661.16,    "description": "Quote for residential solar panel installation.",    "intakeNote": "Partner must co-sign; installer visit booked for 12 March.",    "installer": {      "name": "Warmte Comfort B.V."    },    "externalId": "QUOTE-2024-001",    "tags": [      "smartphone_only",      "less_digitally_skilled"    ],    "financing": {      "phase": "new",      "status": "under_review",      "subStatus": {        "type": "none"      },      "method": [        "loan",        "subsidy"      ],      "waitingOn": "merchant",      "statusChangedAt": "2024-06-15T10:30:00.000Z"    },    "lineItems": [      {        "type": "battery",        "externalId": "QUOTE-2024-001-PV",        "totalInclTax": 12500,        "totalExclTax": 10330.58,        "unitPrice": 250,        "productIdentifiers": {          "brand": "Enphase",          "manufacturerPartNumber": "SE7600H-US",          "globalTradeItemNumber": "0885629362058"        },        "incentiveCodes": [          "ISDE-2024-WP",          "PROV-NH-2024"        ],        "description": "Including installation and commissioning",        "totalNameplateCapacity": 13500,        "totalNameplatePower": 5000,        "lineItemId": "lit_01ARZ3NDEKTSV4RRFFQ69G5FAV"      }    ],    "preferredScenario": {      "currency": "EUR",      "components": [        {          "type": "loan",          "loanProduct": {            "loanProductId": "lprod_01HZXK4Y7R2M9N8P7Q6S5T4V3W",            "slug": "freo-energie-lening",            "name": "Freo Energie Lening",            "lender": {              "lenderId": "lnd_01ARZ3NDEKTSV4RRFFQ69G5FAV",              "slug": "ing",              "name": "ING"            }          },          "amount": 17500,          "numInstallments": 120,          "repaymentPeriodUnit": "months",          "effectiveAnnualRate": 4.5,          "monthlyCost": 178.2        }      ],      "subsidyStrategy": {        "type": "all_deducted"      },      "contingencyReserve": {        "amount": 500,        "percentage": 4      },      "scores": {        "monthlyCost": 312.5,        "totalCostOfCredit": 4200,        "liquidCashRequired": 2000,        "estimatedDaysToFunds": 14      },      "liquidCashAt": "origination",      "selectedAt": "2026-03-01T12:00:00.000Z"    }  },  "links": {    "portalQuote": "https://my.prets.app/organizations/acme/quotes/qot_01ARZ3NDEKTSV4RRFFQ69G5FAV"  }}