Quotes
Change the commercial status of a quote
Moves the OPERATIVE status of the active version of the quote —pending, confirmed or cancelled— and leaves an optional note in the history.
quotes:writequotes:write- 120/min
- May need an add-on
- Server annotation: Idempotent
Result
generated from the schema
Confirming a version moves ALL the others to superseded, including another one that was confirmed: it is the rule that leaves a single one in force, and it is not visible in the body. superseded cannot be set by hand; the system sets it. It does NOT touch the tax status (draft / validated): the document path is for that. It requires sales documents in the plan of the account (402 without it). Returns the full quote, the same projection as its GET.
Arguments
Quote identifier.
Limits: min length 1
New commercial status of the active version: pending (awaiting an answer), confirmed (accepted; the other versions become superseded) or cancelled (rejected or cancelled).
Available options: pending, confirmed, cancelled
Note stored in the quote history alongside the status change.
Limits: max length 1000
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
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.
Name of the linked project; null if not linked.
Tax breakdown by type; null if not calculated.
Show child attributesHide child attributes
Tax type key (for example "IVA_21").
Human-readable tax label.
Tax rate applied, as a percentage (for example 21 for 21%).
Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
Tax amount as a decimal string "1234.50" (ROUND_HALF_UP).
Limits: pattern ^-?\d+\.\d{2}$
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs PATCH /api/v1/quotes/{quoteId}/status.
Related pages
Link to this section: Related pagesQuotes
Change the commercial status of a quote
Moves the OPERATIVE status of the active version of the quote —
pending,confirmedorcancelled— and leaves an optional note in the history.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?