Quotes
List quotes
Returns a paginated list of quotes.
Filters
| Parameter | Description |
|---|---|
| status | Display status: draft, sent, accepted, rejected, expired, converted. Derived statuses are resolved server-side. |
| customerId | Filter to one customer. |
| page / limit | Pagination (defaults: page 1, limit 25, max limit 100). |
| sortBy / sortOrder | Sort field (e.g. date, documentNumber, amount, status, validUntil) and direction. Defaults to newest first. |
query Parameters
pagePage number (1-indexed)
limitItems per page
statusFilter by display status (draft/sent/accepted/rejected/expired/converted). Derived statuses are resolved server-side.
customerIdFilter by customer id
sortBySort field
sortOrderSort order
List quotes › Responses
Paginated list of quotes
List of quotes (line items omitted; GET one quote for lines)
totalTotal number of quotes matching the query
pageCurrent page number (1-indexed)
limitMaximum number of items per page
totalPagesTotal number of pages available
Create a draft quote
Creates a draft quote.
- The quote number is not allocated here — it is assigned on send.
- Totals (subtotal/vat/amount) are computed from the line items.
Create a draft quote › Request Body
customerIdCustomer this quote is for
dateQuote date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
validUntilValid-until date (ISO, YYYY-MM-DD)
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes shown on the quote
Create a draft quote › Responses
Quote created
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)
Get a quote by id
Returns a single quote, including its line items.
path Parameters
idThe quote id
Get a quote by id › Responses
The quote
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)
Update a draft quote
Replaces the editable fields and line items of a draft quote. This is also how
you change validUntil.
Line items are replaced wholesale — send the full intended set. A converted
quote is read-only (SALES_DOCUMENT_LOCKED_CONVERTED).
path Parameters
idThe quote id
Update a draft quote › Request Body
customerIdCustomer this quote is for
dateQuote date (ISO, YYYY-MM-DD)
customerDepartmentIdCustomer department id
customerContactIdCustomer contact id ("Deres ref.")
validUntilValid-until date (ISO, YYYY-MM-DD)
currencyCurrency code
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes shown on the quote
Update a draft quote › Responses
Quote updated
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)
Convert a quote
Converts the quote into the next document in the pre-sales chain:
- A quote converts into an order confirmation (
target: "orderConfirmation"). - A quote can also convert directly into an invoice (
target: "invoice").
By default the quote's fields and line items are copied verbatim. To
review and adjust the target before finalizing, supply an optional document
payload — its fields override the copied values.
A quote converts only once. Re-converting fails with
SALES_DOCUMENT_ALREADY_CONVERTED_TO_INVOICE or
SALES_DOCUMENT_ALREADY_CONVERTED_TO_DOCUMENT.
The response identifies the produced document via targetType
("invoice" or "orderConfirmation") and targetId.
path Parameters
idThe quote id to convert
Convert a quote › Request Body
targetTarget to convert into. Use "orderConfirmation" to confirm the quote, or "invoice" to convert it directly into an invoice.
Edited target document (review-before-finalize). Omit to copy the source verbatim.
Convert a quote › Responses
Conversion result
targetTypeType of document produced by the conversion ("invoice" or "orderConfirmation")
targetIdIdentifier of the produced document
Download a quote as PDF
Renders and streams the quote as a PDF (application/pdf).
Pass ?draft=true to render an unfinalized "draft" watermark preview before
the quote is sent.
path Parameters
idThe quote id
query Parameters
draftRender a draft-watermarked preview when "true".
Download a quote as PDF › Responses
PDF binary stream
Send a quote
Sends the quote. This allocates the quote number (if not already set), renders the PDF, optionally emails it, and marks the quote sent.
Delivery
deliveryType: "Manual"(default) — allocates the number and marks sent without emailing. Use this when you will deliver the PDF yourself (download it viaGET /:id/pdf).deliveryType: "Email"— emails the rendered PDF. The recipient resolves fromrecipientEmail(override), else the customer contact, else the customer email. If none can be resolved the request fails withSALES_DOCUMENT_MISSING_RECIPIENT.
Sproom / e-invoice does not apply to quotes — there is no legal e-invoice type for a quote.
A quote that has already been converted is read-only and cannot be sent
(SALES_DOCUMENT_LOCKED_CONVERTED).
path Parameters
idThe quote id
Send a quote › Request Body
deliveryTypeDelivery method. Defaults to Manual. Sproom/e-invoice does not apply to quotes.
recipientEmailOverride recipient email for Email delivery
Send a quote › Responses
Quote sent
idQuote identifier
typeAlways "quote"
statusStored lifecycle status (draft/sent/accepted/rejected)
displayStatusStatus to display. Equals status except derived states: "converted" or "expired".
dateQuote date (ISO, YYYY-MM-DD)
amountTotal amount including VAT
subtotalSubtotal excluding VAT
vatTotal VAT
currencyCurrency code
createdAtCreated timestamp (ISO)
updatedAtUpdated timestamp (ISO)
documentNumberAllocated quote number (null until sent)
validUntilValid-until date (ISO, YYYY-MM-DD)
referencePO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
notesNotes
customerIdCustomer id
sourceDocumentIdSource document id (set when this quote originated from another document)
convertedToDocumentIdId of the order confirmation this quote was converted into
convertedToInvoiceIdId of the invoice this quote was converted into
sentAtTimestamp the quote was sent (ISO)