Pular para o conteúdo principal

Listar Propostas

Este serviço permite listar propostas com paginação e filtros opcionais para refinar a busca.

Endpoint para Listar Propostas​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/proposal

Parâmetros de Consulta​

Parâmetros de Paginação​

  • page (number, obrigatório): O número da página a ser exibida.
  • pageSize (number, obrigatório): O número de resultados por página.

Parâmetros de Filtro (opcionais)​

Use qualquer combinação dos filtros abaixo para refinar os resultados da consulta:

  • proposalId (string): Filtra pelo ID da proposta.
  • name (string): Filtra pelo nome do cliente.
  • cpf (string): Filtra pelo CPF do cliente.
  • sellerName (string): Filtra pelo nome do vendedor.
  • releasedValue (number): Filtra pelo valor liberado.
  • proposalDate (string, formato ISO): Filtra pela data da proposta.
  • paymentDate (string, formato ISO): Filtra pela data de pagamento.
  • statuses (array de strings): Filtra pelo status da proposta.

    Nota: Possíveis status pendente: PENDING_USER_REVIEW, PENDING_PAYMENT, PENDING_BANK_ANALYSIS, PENDING_FORMALIZATION e PENDING_CONFIRMATION, SELFSERVICE Possíveis status concluídos: PAYED, CANCELED.

Exemplo de Requisição com curl​

curl -X GET 'https://bff-dev.granatech.com.br/api/proposal?page=1&pageSize=10&cpf=12345678900&statuses[]=PENDING_USER_REVIEW&statuses[]=PAYED'

Observações​

  1. Resposta: A resposta será um array contendo objetos de propostas (Proposal), cada um com uma estrutura detalhada dos dados da proposta.
  2. Filtros Opcionais: Utilize qualquer combinação dos filtros opcionais para refinar os resultados da listagem de propostas. Se um filtro não for necessário, ele pode ser omitido da consulta.
  3. Paginação: Configure os parâmetros page e pageSize para controlar a quantidade de resultados exibidos e a página desejada.

Nota Importante: Para ver a estrutura completa do objeto Proposal e detalhes de cada campo, acesse:
👉 Ver objeto de proposta (proposal) completo aqui