4.8. Remover Simulação¶

🔗 Endpoint¶

Método	URL
	/api/v1.1/cartao/agenda/{identificador}/simulacoes/{idSimulacao}

🧾 Descrição¶

Remove (cancela) uma simulação previamente criada e vinculada a uma agenda. A operação libera todos os títulos/URs reservados por essa simulação, atualizando os saldos (valorLivre / valorGarantido) das URs afetadas.

📤 Requisição¶

Nenhum payload no body. O idSimulacao é informado via path parameter.

Path parameters

• identificador (string) — identificador da agenda (GUID).
• idSimulacao (guid) — identificador da simulação a ser removida.

🧪 Exemplo de cURL¶

curl -X DELETE "https://api.veflow.com/api/v1.1/cartao/agenda/534D8AAE-61E4-4264-9D15-715B9E1F1D51/simulacoes/AEB4EA8C-BEF4-4E4E-A009-0A94AF172EAB" \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"

📥 Responses¶

✅ 200 OK¶

{
  "mensagem": "Simulação removida."
}

Indica que a simulação foi removida com sucesso e que os títulos reservados foram liberados.

✅ 204 No Content (opcional)¶

Em alguns fluxos a API pode retornar 204 No Content para indicar sucesso sem body.

❌ 400 Bad Request (exemplo)¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "idSimulacao inválido."
  ]
}

❌ 404 Not Found (exemplo)¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Não encontrado",
  "status": 404,
  "erros": [
    "Agenda '534D8AAE-61E4-4264-9D15-715B9E1F1D51' ou simulação 'AEB4EA8C-BEF4-4E4E-A009-0A94AF172EAB' não encontrada."
  ]
}

❌ 409 Conflict (exemplo — bloqueio operativo)¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Conflito",
  "status": 409,
  "erros": [
    "Simulação não pode ser removida pois está em processo de geração de contrato."
  ]
}

🕒 Observações¶

• A remoção libera imediatamente os títulos/URs reservados pela simulação, tornando-os disponíveis (valorLivre) para outras simulações/ações.
• Autenticação obrigatória via Authorization: Bearer {token}.