Contracts
Cancel a contract operatively
Gives the contract up as not signable: it moves its SIGNATURE status (operativeStatus) to cancelled and leaves the document alive, with its number.
contracts:writecontracts:write- 120/min
- Server annotation: Destructive
- Requires human confirmation
- Not reversible
Result
generated from the schema
Not reversible
This tool cannot be undone.
Requires human confirmation
Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone. The server flags this tool with _meta["anthropic, which clients that honor it use to ask a person before every call.
The reason is optional and is kept in the history. An ALREADY SIGNED contract cannot be cancelled —it rejects the request—: to undo a signature you have to void the document with /void. cancelled is terminal: a cancelled contract can no longer be signed. Returns the full contract, the same projection as its GET.
Arguments
Contract identifier.
Limits: min length 1
Cancellation reason, which is kept in the contract history.
Limits: min length 1, max length 500
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 contract identifier.
Contract number, for example "C260001"; null while it is a draft.
Document status.
Available options: draft, validated, voided
Signature status.
Available options: pending, signed, cancelled
true if the contract is recorded as signed. This is what decides whether the equipment can go out.
Signature date in ISO 8601 UTC; null if not signed.
Customer identifier; null in drafts without a customer.
Associated order; null if it has none.
Number of the associated order; null if it has none.
Associated project; null if it has none.
Contract date in ISO 8601 UTC; null if not set.
Start of validity in ISO 8601 UTC; null if not applicable.
End of validity in ISO 8601 UTC; null if not applicable.
Total amount including taxes as a decimal string "1234.50"; null if not applicable.
Limits: pattern ^-?\d+\.\d{2}$
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
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 POST /api/v1/contracts/{contractId}/cancel.
Related pages
Link to this section: Related pagesContracts
Cancel a contract operatively
Gives the contract up as not signable: it moves its SIGNATURE status (
operativeStatus) tocancelledand leaves the document alive, with its number.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?