Servicios
Actualizar un servicio
Actualiza un servicio (envía solo los campos que cambian).
Ejemplos de petición
curl https://app.filmo.io/api/v1/services/serv_8f2a1c \
--request PATCH \
--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 '{
"priceConfig": {
"hourlyRate": 45,
"perKmRate": 0.42
},
"breakMinutes": 30,
"travelTimeBefore": 60,
"travelTimeAfter": 60,
"defaultExpenses": {
"catering": {
"price": 18
},
"travel": {
"price": 25
}
}
}'Generado a partir del esquema
Incluye la tarifa, los tiempos de desplazamiento y los gastos repercutidos por defecto —de los cuales solo entra el PRECIO, no el coste—. Las listas reemplazan a la existente. Devuelve el servicio actualizado.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. services:write
Cabeceras
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"
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
Identificador del servicio.
Límites: longitud mín. 1
Cuerpo
Esquema del cuerpo: ServiceUpdateBody
Nombre del servicio de cara al cliente.
Límites: longitud mín. 2
Descripción del servicio; null la borra.
Tipo de servicio.
Opciones disponibles: crew, fleet, general
Si aparece como servicio planificable.
Cantidad por defecto.
Límites: mín. 1
Descanso descontado de la jornada de trabajo, en minutos.
Límites: mín. 0
Información impresa en el pedido y en el albarán.
Tarifa del servicio.
Mostrar atributos hijosOcultar atributos hijos
Precio por hora.
Límites: mín. 0
Precio fijo por servicio.
Límites: mín. 0
Precio por kilómetro.
Límites: mín. 0
Si su importe cuenta para el total del documento.
Cómo se calcula la distancia facturable.
Tiempo de viaje previo, en minutos.
Límites: mín. 0
Tiempo de viaje posterior, en minutos.
Límites: mín. 0
Ventana en la que se usa.
Mostrar atributos hijosOcultar atributos hijos
"order" hereda las fechas del pedido; "custom" usa los desplazamientos de abajo.
Opciones disponibles: order, custom
Minutos antes del inicio del pedido.
Límites: mín. 0
Minutos después del fin del pedido.
Límites: mín. 0
Ventana en la que está planificado.
Mostrar atributos hijosOcultar atributos hijos
"order" hereda las fechas del pedido; "custom" usa los desplazamientos de abajo.
Opciones disponibles: order, custom
Minutos antes del inicio del pedido.
Límites: mín. 0
Minutos después del fin del pedido.
Límites: mín. 0
Gastos repercutidos por defecto. Solo el precio, no el coste. Se combinan con los almacenados: las categorías que omitas quedan sin cambios, y cada categoría conserva su coste almacenado.
Mostrar atributos hijosOcultar atributos hijos
Dietas.
Mostrar atributos hijosOcultar atributos hijos
Lo que se cobra al cliente por este concepto.
Viaje.
Mostrar atributos hijosOcultar atributos hijos
Lo que se cobra al cliente por este concepto.
Alojamiento.
Mostrar atributos hijosOcultar atributos hijos
Lo que se cobra al cliente por este concepto.
Otros gastos.
Mostrar atributos hijosOcultar atributos hijos
Lo que se cobra al cliente por este concepto.
Recursos necesarios. Reemplaza la lista completa.
Mostrar atributos hijosOcultar atributos hijos
Lo necesario para prestarlo: personal o vehículo.
Opciones disponibles: personnel, vehicle
Cuántos hacen falta.
Límites: mín. 1
Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".
Límites: máx. 20 elementos, cada uno: longitud máx. 100
Colección a la que pertenece.
URL de las imágenes del servicio.
Respuesta
Respuesta correcta.
Esquema de la respuesta: ServiceDto
Sobre: ServiceResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay
Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del servicio.
Nombre del servicio tal como lo ve el cliente.
Tipo: crew (personal), fleet (vehículos) o general.
Descripción; null si no tiene.
Cantidad que se añade por defecto a un pedido.
Si aparece como servicio planificable.
Si su importe cuenta para el total del documento.
Ruta de la colección a la que pertenece; null si no está en ninguna.
Recursos necesarios para prestarlo.
Mostrar atributos hijosOcultar atributos hijos
Lo necesario para prestarlo: personal o vehículo.
Opciones disponibles: personnel, vehicle
Cuántos hacen falta.
Límites: mín. 1
Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".
Límites: máx. 20 elementos, cada uno: longitud máx. 100
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).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
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 · Idempotent-Replay
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 · Idempotent-Replay
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 · Idempotent-Replay
Conflicto (conflict): el estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, o otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Precondición fallida (precondition_failed): la etiqueta de entidad If-Match no coincide con la representación actual. Lee el recurso de nuevo y reintenta.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Idempotency-Key reutilizada (idempotency_key_reused): la misma clave se usó antes con un cuerpo distinto. Cambia la clave.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
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 · Idempotent-Replay
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Idempotent-Replay
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
| 404 | not_found | No existe o queda fuera del alcance de la clave de API. |
| 409 | conflict | El 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]. indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación. |
| 412 | precondition_failed | La etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta. |
| 422 | idempotency_key_reused | La 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
Relacionado
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasOperaciones
Servicio
Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.
¿Te ha resultado útil esta página?