Contracts
Get a contract
Returns the detail of a contract by its identifier.
contracts:readcontracts:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Arguments
Contract identifier.
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 GET /api/v1/contracts/{contractId}.
Related pages
Link to this section: Related pagesContracts
Get a contract
Returns the detail of a contract by its identifier.
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?