1. Propostas
  • Raiz
    • Comece por aqui
      • Teste de integridade
      • Autenticação — minha conta
    • Tabelas
      • Listar tabelas de operação
    • Propostas
      • Digitar proposta
        POST
      • Listar propostas
        GET
      • Consultar proposta
        GET
      • Linha do tempo da proposta
        GET
    • Tempo real
      • Status em tempo real (SSE)
    • Webhooks
      • Registrar webhook
      • Listar webhooks
      • Remover webhook
      • Disparar teste
      • Histórico de entregas
    • MCP (integração com IA)
      • Integrar com IA — Servidor MCP
  • Esquemas
    • Fase
    • TipoEvento
    • Evento
    • NovaProposta
    • Proposta
  1. Propostas

Consultar proposta

Sandbox
http://localhost:4500/api/v1
Sandbox
http://localhost:4500/api/v1
GET
/propostas/{codigo}
Consulta uma proposta pelo código — fase atual na esteira, dados, pendências e eventos recentes.

Requisição

Parâmetros de Caminho

Respostas

🟢200OK
application/json
Proposta com pendências e eventos recentes
Bodyapplication/json

🟠404Registo Não Encontrado
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://localhost:4500/api/v1/propostas/NXX-20260708-0001'
Response Response Example
200 - Exemplo 1
{
    "codigo": "NXX-20260708-0001",
    "fase": "digitada",
    "origem": "api",
    "referencia_externa": "string",
    "cliente": {
        "cpf": "529.982.247-25",
        "nome": "string",
        "dt_nascimento": "string",
        "matricula": "string",
        "sexo": "string",
        "celular": "string",
        "email": "string"
    },
    "operacao": {
        "convenio": "Gov. Goiás",
        "banco_origem": "string",
        "tabela_id": 0,
        "tabela_nome": "string",
        "parcela": 0,
        "saldo_devedor": 0,
        "coeficiente": 0,
        "seguro": 0,
        "bruto_liberado": 0,
        "troco": 0
    },
    "criada_em": "2019-08-24T14:15:22.123Z",
    "atualizada_em": "2019-08-24T14:15:22.123Z",
    "pendencias": [
        {
            "id": 0,
            "motivo": "string",
            "observacao": "string",
            "situacao": "aberta",
            "criada_em": "2019-08-24T14:15:22.123Z",
            "resolvida_em": "2019-08-24T14:15:22.123Z"
        }
    ],
    "eventos_recentes": [
        {
            "id": "evt_c8c8897f4637dec114c02484",
            "tipo": "proposta.criada",
            "fase_anterior": "digitada",
            "fase_atual": "digitada",
            "origem": "api",
            "detalhes": {},
            "criado_em": "2019-08-24T14:15:22.123Z"
        }
    ]
}
Modificado em 2026-07-08 01:52:25
Página anterior
Listar propostas
Próxima página
Linha do tempo da proposta
Built with