---
title: 4.9. Lista de Simulações
url: https://docs.vehub.com.br/API/VeFlow%20-%20Cart%C3%A3o%20de%20cr%C3%A9dito/4.%20Agenda%20de%20receb%C3%ADveis/v1.1/4.9.%20Lista%20de%20simula%C3%A7%C3%B5es/
---
# 4.9. Lista de Simulações

## 🔗 Endpoint

| Método                                               | URL                                                  |
| ---------------------------------------------------- | ---------------------------------------------------- |
| ![GET](https://img.shields.io/badge/GET-brightgreen) | `/api/v1.1/cartao/agenda/{identificador}/simulacoes` |

---

## 🧾 Descrição

Retorna a **lista de simulações** vinculadas a uma determinada agenda. Cada item do retorno representa uma simulação previamente criada (efetivada) dentro do contexto da agenda, incluindo suas configurações, parâmetros de execução e totais consolidados.

---

## 📥 Response

### ✅ 200 OK

```json
{
  "itens": [
    {
      "guid": "",
      "tipoContrato": 1,
      "taxa": null,
      "tipoVinculo": 1,
      "valor": 1,
      "ordem": null,
      "parcelaNumero": 1,
      "parcelaTotal": 1,
      "parcelaValor": 1.00,
      "parcelaData": "2025-09-09",
      "dataInicial": "2025-09-09",
      "dataFinal": "2025-09-09",
      "tipoValor": 1,
      "fumacaValor": 1.00,
      "origem": 1,
      "contratoErp": "",
      "contratoValor": 1.00,
      "personalizaPerformance": true,
      "somenteUrPerformada": true,
      "tipoAlertaPerformance": null,
      "alertaResilicao": false,
      "totais": {
        "valorAtingido": 1.00,
        "valorNaoAtingido": 0.00,
        "quantidadeUR": 1
      }
    }
  ]
}
```

---

## 🧾 Detalhamento dos Campos

### 🔹 Nível Raiz

| Campo | Tipo  | Descrição                                               |
| ----- | ----- | ------------------------------------------------------- |
| itens | array | Lista de simulações pertencentes à agenda especificada. |

### 🔹 Estrutura dos Itens

| Campo                  | Tipo         | Descrição                                                                          |
| ---------------------- | ------------ | ---------------------------------------------------------------------------------- | 
| guid                   | string       | GUID único da simulação.                                                           |
| tipoContrato           | integer      | Tipo de contrato vinculado (1 = padrão, outros valores conforme enum interno).     |
| taxa                   | number/null  | Taxa (deságio) aplicada à simulação, quando houver.                                |
| tipoVinculo            | integer      | Define a origem do vínculo (`1` = valor desejado, `2` = UR manual, etc.).          |
| valor                  | number       | Valor principal da simulação (pode ser valor desejado ou garantido).               |
| ordem                  | string/null  | Ordem utilizada na vinculação (`ASC` ou `DESC`).                                   |
| parcelaNumero          | integer      | Número da parcela (quando a simulação estiver associada a uma garantia parcelada). |
| parcelaTotal           | integer      | Total de parcelas previstas.                                                       |
| parcelaValor           | number       | Valor da parcela associada à simulação.                                            |
| parcelaData            | string       | Data de vencimento da parcela vinculada.                                           |
| dataInicial            | string       | Data inicial do intervalo considerado na simulação.                                |
| dataFinal              | string       | Data final do intervalo considerado na simulação.                                  |
| tipoValor              | integer      | Tipo de valor considerado na simulação (enum).                                     |
| fumacaValor            | number       | Valor total da simulação em cenários de crédito fumaça.                            |
| origem                 | integer      | Indica a origem da simulação (manual, automática, etc.).                           |
| contratoErp            | string       | Código do contrato no ERP do cliente, quando houver.                               |
| contratoValor          | number       | Valor total do contrato de origem.                                                 |
| personalizaPerformance | boolean      | Indica se houve personalização de performance (true = sim).                        |
| somenteUrPerformada    | boolean      | Indica se a simulação considera apenas URs performadas.                            |
| tipoAlertaPerformance  | integer/null | Tipo de alerta de performance, se aplicável.                                       |
| alertaResilicao        | boolean      | Indica se houve alerta de resiliência na simulação.                                |
| totais                 | object       | Totais consolidados da simulação (ver abaixo).                                     |

### 🔹 totais

| Campo            | Tipo    | Descrição                                            |
| ---------------- | ------- | ---------------------------------------------------- |
| valorAtingido    | number  | Valor total atingido na simulação.                   |
| valorNaoAtingido | number  | Valor não atingido (saldo remanescente não coberto). |
| quantidadeUR     | integer | Quantidade de URs envolvidas na simulação.           |

---

## 🧪 Exemplo de cURL

```bash
curl -X GET https://api.veflow.com/api/v1.1/cartao/agenda/534D8AAE-61E4-4264-9D15-715B9E1F1D51/simulacoes \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json"
```

---

## 🕒 Observações

* Este endpoint retorna apenas simulações persistidas (efetivamente criadas via POST `/simulacao`).
* Autenticação obrigatória via `Authorization: Bearer {token}`.