Skip to main content
POST
Create a quote

Authorizations

Authorization
string
header
required

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

Headers

Prets-Organization
string

Target merchant organization slug.

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: 0 <= x <= 250000
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

Quote term and condition

Available options:
subject_to_financing
Example:
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: 0 <= x <= 250000
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:
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

Hypermedia navigation links