Contracts

Void a contract

Voids a VALIDATED contract with a reason, which is required and is kept.

Tool
filmo_contracts_void
Access: Destructive

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_contracts_void",
    "arguments": {
      "contractId": "cont_8f2a1c",
      "reason": "<reason>"
    }
  }
}

generated from the schema

Not reversible

Voiding takes the document to voided, and no operation undoes it.

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/requiresUserInteraction"], which clients that honor it use to ask a person before every call.

It keeps its number and moves to voided: it moves the DOCUMENT status and removes its validity, signed or not. Only from validated: a draft is deleted from the application, not voided. It is NOT /cancel, which moves the signature status and leaves the document alive. Returns the full contract, the same projection as its GET.

Arguments

contractIdstringRequired

Contract identifier.

Limits: min length 1

reasonstringRequired

Void reason. It is stored in the contract and in its history.

Limits: min length 1, max length 500

idempotencyKeystring

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

ifMatchstring

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
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 POST /api/v1/contracts/{contractId}/void.

  • Contracts

    Void a contract

    Voids a VALIDATED contract with a reason, which is required and is kept.

  • 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.