2.4. Consultar Simulação¶

🔗 Endpoint¶

Método	URL
	`/public/api/v1/duplicata-escritural/simulacoes/{identificadorSimulacao}`

🧾 Descrição¶

Consulta os detalhes de uma simulação previamente criada, incluindo o status da agenda, os totais financeiros calculados e a lista paginada de duplicatas encontradas com seus valores de aquisição.

🧾 Parâmetros¶

Parâmetro	Tipo	Local	Obrigatório	Descrição
identificadorSimulacao	string	Path	Sim	GUID da simulação a ser consultada
indicePagina	integer	Query	Não	Índice da página (padrão: 1)
tamanhoDaPagina	integer	Query	Não	Quantidade de registros por página (padrão: 10)

🧪 Exemplo de cURL¶

curl -X GET "https://api.vehub.com.br/public/api/v1/duplicata-escritural/simulacoes/534D8AAE-61E4-4264-9D15-715B9E1F1D51?indicePagina=1&tamanhoDaPagina=10" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \

📥 Response¶

✅ 200 OK¶

{
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "simulacao": {
    "statusAgenda": 1,
    "motivoFalha": ""
  },
  "totais": {
    "nominal": 50000.00,
    "desconto": 625.00,
    "aquisicao": 49375.00,
    "taxa": 1.25,
    "disponivel": 49375.00
  },
  "duplicatas": {
    "registros": [
      {
        "identificadorExterno": "7D121577-3C5A-494D-B052-291D9E100D0D",
        "sacadorDocumento": "12345678000199",
        "sacadoDocumento": "98765432000155",
        "dataVencimento": "2025-10-15",
        "valorDuplicata": 5000.00,
        "valorDesconto": 62.50,
        "valorAquisicao": 4937.50,
        "selecionado": false
      }
    ],
    "paginacao": {
      "paginaAtual": 1,
      "paginaTotal": 1,
      "paginaQuantidadeRegistro": 10,
      "quantidadeRegistros": 1,
      "temPaginaAnterior": false,
      "temProximaPagina": false
    },
    "mensagem": null
  }
}

🧾 Detalhamento dos Campos¶

🔹 simulacao¶

Campo	Tipo	Descrição
statusAgenda	integer	Status da agenda da simulação (ver StatusAgenda)
motivoFalha	string	Motivo da falha caso o status indique erro

🔢 StatusAgenda¶

Código	Significado
1	Agenda disponível
2	Agenda vazia
3	Agenda ultrapassou tempo de publicação
4	Agenda com falha

🔹 totais¶

Campo	Tipo	Descrição
nominal	number	Valor total nominal das duplicatas
desconto	number	Soma dos deságios calculados
aquisicao	number	Valor líquido total a ser desembolsado
taxa	number	Taxa aplicada na simulação
disponivel	number	Valor disponível para operação

🔹 duplicatas.registros¶

Campo	Tipo	Descrição
identificadorExterno	string	GUID externo da duplicata
sacadorDocumento	string	CNPJ/CPF do sacador (somente números)
sacadoDocumento	string	CNPJ/CPF do sacado (somente números)
dataVencimento	string	Data de vencimento da duplicata (YYYY-MM-DD)
valorDuplicata	number	Valor nominal da duplicata
valorDesconto	number	Valor do deságio calculado
valorAquisicao	number	Valor líquido após desconto
selecionado	boolean	Indica se a duplicata está selecionada para contratação

🔹 duplicatas.paginacao¶

Campo	Tipo	Descrição
paginaAtual	integer	Número da página atual
paginaTotal	integer	Total de páginas disponíveis
paginaQuantidadeRegistro	integer	Tamanho da página configurado
quantidadeRegistros	integer	Total de registros encontrados
temPaginaAnterior	boolean	Indica se existe página anterior
temProximaPagina	boolean	Indica se existe próxima página

🕒 Observações¶

Use os parâmetros indicePagina e tamanhoDaPagina para navegar pelas duplicatas da simulação.
O campo selecionado indica se a duplicata foi vinculada à simulação via 7.3. Vincular Duplicatas.
O campo motivoFalha é preenchido apenas quando o statusAgenda indicar falha.