Quotes
List quotes
Returns the quotes with their active version flattened, cursor-paginated.
quotes:readquotes:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by commercial or operational status. Strict per-subscription tenancy.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Free-text search on the quote number, the order number, the notes, the header text and the client name.
Limits: min length 1, max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, quoteNumber, issueDate, startDate, endDate, subTotal, grossPrice, operativeStatus. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Filter by commercial status of the active version: pending (awaiting an answer), confirmed (accepted), cancelled (rejected/cancelled) or superseded (replaced by another version).
Available options: pending, confirmed, cancelled, superseded
Filter by operativeStatus, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: pending, confirmed, cancelled, superseded
Limits: min 1 items, max 50 items
Filter by quote contact identifier.
Limits: min length 1, max length 100
Filter by contactId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by identifier of the order linked to the quote.
Limits: min length 1, max length 100
Filter by orderId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Filter by identifier of the project linked to the quote.
Limits: min length 1, max length 100
Filter by projectId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Limits: min 1 items, max 50 items, each min length 1, each max length 100
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, issueDate, updated, validUntil.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique quote identifier (container).
Human-readable quote number.
Number of the active version of the quote.
Document lifecycle status of the active version: draft or validated (validated and numbered).
Available options: draft, validated
Commercial status of the active version: pending (awaiting an answer), confirmed (accepted), cancelled (rejected/cancelled) or superseded (replaced).
Available options: pending, confirmed, cancelled, superseded
Issue date of the active version in ISO 8601 with offset; null if not issued.
Validity date of the quote in ISO 8601 with offset; null if not set.
Start of the quoted rental period in ISO 8601 with offset.
End of the quoted rental period in ISO 8601 with offset.
Quote currency as an ISO 4217 code (for example "EUR").
Compact reference to the quote contact; null if none.
Show child attributesHide child attributes
Unique contact identifier.
Contact name.
Identifier of the linked order; null if not linked.
Number of the linked order; null if not linked.
Identifier of the linked project; null if not linked.
Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Total discounts as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Tax total as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Amount collected against the quote as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.
Limits: pattern ^-?\d+\.\d{2}$
Creation date of the container in ISO 8601 with offset.
Last update date in ISO 8601 with offset.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Which quotes are still open for the Spring catalogue project?
The same operation by REST
This tool runs GET /api/v1/quotes.
Related pages
Link to this section: Related pagesQuotes
List quotes
Returns the quotes with their active version flattened, cursor-paginated.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?