A API oferece funcionalidades para criação, consulta e gerenciamento de propostas, permitindo que as negociações de antecipação de recebíveis ocorram de forma estruturada e eficiente. Os métodos disponíveis possibilitam a busca de propostas, o envio de novas ofertas, a aceitação ou recusa de propostas e o cancelamento de negociações quando necessário.

Find Proposals by Query Filters

Realiza a busca de propostas registradas na plataforma com base em critérios definidos, permitindo a recuperação de registros conforme os filtros aplicados.

📌 Endpoint

  • Método: GET
  • Endpoint: /proposals

Os filtros disponíveis possibilitam a segmentação das propostas, tornando a consulta mais precisa e direcionada.

Create Proposal

Permite o envio de uma nova proposta de antecipação, vinculando-se a uma oferta/agenda existente e especificando as condições da negociação.

📌 Endpoint

  • Método: POST
  • Endpoint: /proposals/offer

Após a criação, a proposta será registrada com um ID único, permitindo seu acompanhamento e gerenciamento até a conclusão da negociação.

Accept or Deny

Permite a aceitação ou recusa de uma proposta enviada, possibilitando que a negociação siga para a fase de formalização ou seja finalizada sem acordo.

📌 Endpoint

  • Método: PUT
  • Endpoint: /proposals/{id}

O ID da proposta deve ser informado para que a ação seja aplicada corretamente, garantindo que apenas propostas válidas sejam processadas.

Cancel Proposal

Permite o cancelamento de uma proposta que ainda não foi concluída, interrompendo a negociação antes da formalização do contrato.

📌 Endpoint

  • Método: PUT
  • Endpoint: /proposals/cancel/{id}

O ID da proposta deve ser informado para que a API registre a ação, garantindo que a proposta seja removida da lista de negociações ativas.

Status

StatusDescrição
DisponívelProposta disponível para receber oferta.
ExpiradoProposta passou do período para receber oferta.
Em NegociaçãoAguardando o adquirente aceitar ou recusar a oferta.
AprovadoProposta aceita pelo adquirente, investidor deve realizar o upload do contrato.
CanceladoAdquirente não aceitou a oferta.
NegociadoProposta aceita pelo adquirente e o contrato já foi colocado dentro da plataforma.
LiquidadoRecebível liquidado.
IndisponívelRecebíveis zerados (não aparecem na visualização).