Contratos

Cancelar un contrato a efectos operativos

Da el contrato por no firmable: pasa su estado de FIRMA (operativeStatus) a cancelled y deja el documento vivo, con su número.

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

Ejemplos de petición

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"
}'
{
  "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"
  }
}

Generado a partir del esquema

No reversible

Esta operación no se puede deshacer.

El motivo es opcional y se guarda en el historial. Un contrato YA FIRMADO no se puede cancelar —rechaza la petición—: para deshacer una firma hay que anular el documento con /void. cancelled es terminal: un contrato cancelado ya no se puede firmar. Devuelve el contrato completo, la misma proyección que su GET.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. contracts:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

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

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

contractIdstringObligatorio

Identificador del contrato.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: ContractCancelBody

reasonstring

Motivo de la cancelación, que se guarda en el historial del contrato.

Límites: longitud mín. 1, longitud máx. 500

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ContractDto

Sobre: ContractResponse. meta.warnings solo aparece cuando la operación está obsoleta.

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

dataobject

Contrato de alquiler. No incluye las cláusulas legales ni la instantánea fiscal del cliente.

Mostrar atributos hijos
data.idstring

Identificador único del contrato.

data.contractNumberstring | null

Número del contrato, por ejemplo "C260001"; null mientras es un borrador.

data.statusstring

Estado del documento.

Opciones disponibles: draft, validated, voided

data.operativeStatusstring

Estado de la firma.

Opciones disponibles: pending, signed, cancelled

data.signedboolean

true si el contrato consta como firmado. Es lo que decide si el equipo puede salir.

data.signedAtstring<date-time> | null

Fecha de firma en ISO 8601 UTC; null si no está firmado.

data.contactIdstring | null

Identificador del cliente; null en borradores sin cliente.

data.orderIdstring | null

Pedido asociado; null si no tiene.

data.orderNumberstring | null

Número del pedido asociado; null si no tiene.

data.projectIdstring | null

Proyecto asociado; null si no tiene.

data.contractDatestring<date-time> | null

Fecha del contrato en ISO 8601 UTC; null si no está definida.

data.startDatestring<date-time> | null

Inicio de la vigencia en ISO 8601 UTC; null si no aplica.

data.endDatestring<date-time> | null

Fin de la vigencia en ISO 8601 UTC; null si no aplica.

data.grossPricestring | null

Importe total con impuestos como cadena decimal "1234.50"; null si no aplica.

Límites: patrón ^-?\d+\.\d{2}$

data.createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

data.updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

¿Te ha resultado útil esta página?