Ir al contenido

Cerrar plan de gasto

PUT /v1/spending-plans/{id}/close

Cierra un plan de gasto activo. Podés cerrarlo de dos formas, según el mode:

  • Inmediato (immediate): termina el plan al instante → estado TERMINATED.
  • Con período de gracia (grace_period): inicia una ventana de gracia → estado GRACE_PERIOD. Uvicuo liquida el plan (SETTLED) al final de esa ventana. La duración de la gracia la define Uvicuo (configuración de la empresa); no se envía en la llamada.
ParámetroEnTipoDescripción
idrutastring (UUID)Identificador del plan de gasto a cerrar.
modecuerpo"immediate" | "grace_period"Obligatorio. Modo de cierre.
{ "mode": "immediate" }
Ventana de terminal
curl -X PUT \
https://api.sandbox.partner.uvicuo.com/v1/spending-plans/3f7c1e90-2b8a-4c5d-9e10-aa11bb22cc33/close \
-H "X-API-Key: $UVICUO_API_KEY" \
-H "content-type: application/json" \
-d '{"mode":"grace_period"}'

200 OK — devuelve el plan de gasto actualizado. Revisa su estado resultante:

modeEstado resultanteSignificado
immediateTERMINATEDEl plan quedó terminado de inmediato.
grace_periodGRACE_PERIODEl plan entró en su ventana de gracia; Uvicuo lo liquidará (SETTLED) al finalizar. El state_info incluye ended_at.
SituaciónHTTPcodeCómo evitarlo
El plan no puede cerrarse en su estado actual (no está activo, o ya está terminado/liquidado).409plan_not_closableVerifica el estado con Listar planes; solo un plan activo o en gracia se puede cerrar.
No existe un plan con ese id.404not_foundUsa un id válido (búscalo por tu trip_id).
Falta mode o tiene un valor inválido.400validation_errorEnviá mode: immediate o grace_period.
El id de la ruta no es un UUID válido.400validation_error—

Ver Errores para el formato completo.