Contratos
Obtener un contrato
Devuelve el detalle de un contrato por su identificador.
Ejemplos de petición
curl https://app.filmo.io/api/v1/contracts/cont_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. contracts:read
Cabeceras
Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador del contrato.
Límites: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: ContractDto
Sobre: ContractResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Contrato de alquiler. No incluye las cláusulas legales ni la instantánea fiscal del cliente.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contrato.
Número del contrato, por ejemplo "C260001"; null mientras es un borrador.
Estado del documento.
Opciones disponibles: draft, validated, voided
Estado de la firma.
Opciones disponibles: pending, signed, cancelled
true si el contrato consta como firmado. Es lo que decide si el equipo puede salir.
Fecha de firma en ISO 8601 UTC; null si no está firmado.
Identificador del cliente; null en borradores sin cliente.
Pedido asociado; null si no tiene.
Número del pedido asociado; null si no tiene.
Proyecto asociado; null si no tiene.
Fecha del contrato en ISO 8601 UTC; null si no está definida.
Inicio de la vigencia en ISO 8601 UTC; null si no aplica.
Fin de la vigencia en ISO 8601 UTC; null si no aplica.
Importe total con impuestos como cadena decimal "1234.50"; null si no aplica.
Límites: patrón ^-?\d+\.\d{2}$
Fecha de creación en ISO 8601 UTC; null si no consta.
Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
No modificado: el If-None-Match enviado coincide con el ETag actual. Sin cuerpo; la copia que tienes está al día.
Cabeceras: ETag
Sin cuerpo.
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
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
Relacionado
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasAlquileres
Contrato
Contrato de alquiler.
¿Te ha resultado útil esta página?