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.

POST

/api/v1/contracts/{contractId}/cancel

curl https://app.filmo.io/api/v1/contracts/cont_8f2a1c/cancel \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "El cliente se echa atrás antes de firmar"
}'

Node.jsfetch('https://app.filmo.io/api/v1/contracts/cont_8f2a1c/cancel', { method: 'POST', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ reason: 'El cliente se echa atrás antes de firmar' }) })Pythonimport uuid import requests requests.post( "https://app.filmo.io/api/v1/contracts/cont_8f2a1c/cancel", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "reason": "El cliente se echa atrás antes de firmar" } )

{
  "data": {
    "id": "contract_9f3a2b",
    "contractNumber": "2026-0001",
    "status": "draft",
    "operativeStatus": "pending",
    "signed": true,
    "signedAt": "2026-09-01T08:00:00.000Z",
    "contactId": "contact_9f3a2b",
    "orderId": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "projectId": "project_9f3a2b",
    "contractDate": "2026-09-01T08:00:00.000Z",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "grossPrice": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "contracts:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

Not reversible

This operation cannot be undone.

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.

Authorizations

Bearer API key with the scope below. contracts:write

Headers

Idempotency-Keystring

Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

contractIdstringRequired

Contract identifier.

Limits: min length 1

Body

application/json

Body schema: ContractCancelBody

reasonstring

Cancellation reason, which is kept in the contract history.

Limits: min length 1, max length 500

Response

application/json

Successful response.

Response schema: ContractDto

Envelope: ContractResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Rental contract. Does not include the legal clauses or the tax snapshot of the customer.

Show child attributes

data.idstring

Unique contract identifier.

data.contractNumberstring | null

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

data.statusstring

Document status.

Available options: draft, validated, voided

data.operativeStatusstring

Signature status.

Available options: pending, signed, cancelled

data.signedboolean

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

data.signedAtstring<date-time> | null

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

data.contactIdstring | null

Customer identifier; null in drafts without a customer.

data.orderIdstring | null

Associated order; null if it has none.

data.orderNumberstring | null

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

data.projectIdstring | null

Associated project; null if it has none.

data.contractDatestring<date-time> | null

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

data.startDatestring<date-time> | null

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

data.endDatestring<date-time> | null

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

data.grossPricestring | null

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

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

data.createdAtstring<date-time> | null

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

data.updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
404	`not_found`	It does not exist or is outside the scope of the API key.
409	`conflict`	The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation.
412	`precondition_failed`	The `If-Match` entity tag does not match the current representation. Read the resource again and retry.
422	`idempotency_key_reused`	The same key was used before with a different body. Change the key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Rentals
Contract
Rental contract.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Body

Response

Errors

Deprecation

Related

Related pages

Contract