Contracts

Get a contract

Returns the detail of a contract by its identifier.

Tool
filmo_contracts_get
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_contracts_get",
    "arguments": {
      "contractId": "cont_8f2a1c"
    }
  }
}

generated from the schema

Arguments

contractIdstringRequired

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
idstring

Unique contract identifier.

contractNumberstring | null

Contract number, for example "C260001"; null while it is a draft.

statusstring

Document status.

Available options: draft, validated, voided

operativeStatusstring

Signature status.

Available options: pending, signed, cancelled

signedboolean

true if the contract is recorded as signed. This is what decides whether the equipment can go out.

signedAtstring<date-time> | null

Signature date in ISO 8601 UTC; null if not signed.

contactIdstring | null

Customer identifier; null in drafts without a customer.

orderIdstring | null

Associated order; null if it has none.

orderNumberstring | null

Number of the associated order; null if it has none.

projectIdstring | null

Associated project; null if it has none.

contractDatestring<date-time> | null

Contract date in ISO 8601 UTC; null if not set.

startDatestring<date-time> | null

Start of validity in ISO 8601 UTC; null if not applicable.

endDatestring<date-time> | null

End of validity in ISO 8601 UTC; null if not applicable.

grossPricestring | null

Total amount including taxes as a decimal string "1234.50"; null if not applicable.

Limits: pattern ^-?\d+\.\d{2}$

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

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].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/contracts/{contractId}.

  • Contracts

    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: true and the problem in the first text block. Branch on its code.