Skip to main content
POST
/
v1
/
quotes
Create a quote
curl --request POST \
  --url https://api.prets.io/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "postalCode": "1000 AA",
    "houseNumber": "42",
    "city": "Brussels",
    "street": "Kerkstraat",
    "houseNumberAddition": "A"
  },
  "contact": {
    "email": "jan.jansen@example.nl",
    "lastName": "Jansen",
    "phoneNumber": "+31612345678",
    "firstName": "Jan"
  },
  "currency": "EUR",
  "totalInclTax": 25000,
  "lineItems": [
    {
      "totalInclTax": 12500,
      "externalId": "QUOTE-2024-001-PV",
      "totalExclTax": 10330.58,
      "unitPrice": 250,
      "productIdentifiers": {
        "brand": "Enphase",
        "manufacturerPartNumber": "SE7600H-US",
        "globalTradeItemNumber": "0885629362058"
      },
      "incentiveCodes": [
        "ISDE-2024-WP",
        "PROV-NH-2024"
      ],
      "description": "<string>",
      "totalNameplateCapacity": 13500,
      "totalNameplatePower": 5000
    }
  ],
  "terms": [
    "subject_to_financing"
  ],
  "expiresAt": "2024-12-31T23:59:59Z",
  "sentAt": "2024-06-15T10:30:00Z",
  "totalExclTax": 20661.16,
  "description": "<string>",
  "externalId": "QUOTE-2024-001",
  "tags": [
    "smartphone_only",
    "less_digitally_skilled"
  ],
  "quoteId": "<string>"
}
'
{
  "data": {
    "quoteId": "qot_01ARZ3NDEKTSV4RRFFQ69G5AV",
    "opportunity": {
      "opportunityId": "opp_01ARZ3NDEKTSV4RRFFQ69G5AV"
    },
    "createdAt": "2024-06-15T10:30:00.000Z",
    "updatedAt": "2024-06-15T10:30:00.000Z",
    "address": {
      "postalCode": "1000 AA",
      "houseNumber": "42",
      "city": "Brussels",
      "street": "Kerkstraat",
      "houseNumberAddition": "A"
    },
    "contact": {
      "email": "jan.jansen@example.nl",
      "lastName": "Jansen",
      "phoneNumber": "+31612345678",
      "firstName": "Jan"
    },
    "currency": "EUR",
    "totalInclTax": 25000,
    "financing": {
      "statusChangedAt": "2024-06-15T10:30:00.000Z",
      "subStatus": {
        "description": "Waiting on the signed contract"
      }
    },
    "lineItems": [
      {
        "totalInclTax": 12500,
        "lineItemId": "<string>",
        "externalId": "QUOTE-2024-001-PV",
        "totalExclTax": 10330.58,
        "unitPrice": 250,
        "productIdentifiers": {
          "brand": "Enphase",
          "manufacturerPartNumber": "SE7600H-US",
          "globalTradeItemNumber": "0885629362058"
        },
        "incentiveCodes": [
          "ISDE-2024-WP",
          "PROV-NH-2024"
        ],
        "description": "<string>",
        "totalNameplateCapacity": 13500,
        "totalNameplatePower": 5000
      }
    ],
    "terms": [
      "subject_to_financing"
    ],
    "expiresAt": "2024-12-31T23:59:59Z",
    "sentAt": "2024-06-15T10:30:00Z",
    "totalExclTax": 20661.16,
    "description": "<string>",
    "externalId": "QUOTE-2024-001",
    "tags": [
      "smartphone_only",
      "less_digitally_skilled"
    ]
  },
  "links": {
    "session": "https://app.prets.io/session?ticket=abc123"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.prets.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Prets-Organization
string

The organization slug to create the quote for.

Example:

"prets"

​
Idempotency-Key
string<uuid>

Optional client-generated UUID for idempotent retries. If omitted, a key is derived from the request body.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Query Parameters

​
session
boolean | null
default:false

Include a single-use session URL in the response

Example:

true

Body

application/json

Create a new quote for sustainability home improvements

​
address
object
required

Installation address (Dutch or international format based on country)

​
contact
object
required

Contact payload without server-assigned id (e.g. quote create/update body)

​
currency
enum<string>
required

Quote currency (currently EUR only)

Available options:
EUR
Example:

"EUR"

​
totalInclTax
number
required

Total quote amount including tax in EUR

Required range: x >= 0
Example:

25000

​
lineItems
object[]
required

Line items for the quote (at least one required)

Minimum array length: 1

Battery storage system line item

​
terms
enum<string>[]

Quote terms and conditions

Minimum array length: 1
Available options:
subject_to_financing
Example:
["subject_to_financing"]
​
expiresAt
string<date>

Quote expiration timestamp (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

​
sentAt
string<date>

Timestamp when quote was sent to customer (ISO 8601)

Example:

"2024-06-15T10:30:00Z"

​
totalExclTax
number

Total quote amount excluding tax in EUR

Required range: x >= 0
Example:

20661.16

​
description
string

Description of the quote

Minimum string length: 1
​
externalId
string

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

Minimum string length: 1
Example:

"QUOTE-2024-001"

​
tags
enum<string>[]

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

Minimum array length: 1

Special circumstances and support requirements that ops team should be aware of

Available options:
smartphone_only,
landline_only,
less_digitally_skilled,
financially_complex,
moderately_complex_finances,
prefers_phone_contact,
prefers_email_contact
Example:
["smartphone_only", "less_digitally_skilled"]
​
quoteId
string

Client-generated id (qot_{ULID}). When provided the server uses this as the canonical quote ID, enabling optimistic UI on the client.

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

Response

Quote created successfully

Quote creation response

​
data
object
required

A quote for sustainability home improvements

​
links
object

Hypermedia navigation links