Recebível

A API disponibiliza métodos para consulta e recuperação de recebíveis, permitindo que os dados sejam acessados e utilizados conforme as necessidades do sistema. Esses métodos possibilitam a busca filtrada, o download de registros específicos e a obtenção de informações sobre os emissores dos recebíveis.

Find Receivable by Query Filters

Realiza a busca de recebíveis cadastrados com base em critérios definidos pelo usuário, permitindo a filtragem de registros conforme parâmetros específicos.

📌 Endpoint

Método: GET
Endpoint: /receivables

Os filtros aplicáveis permitem segmentar a consulta, tornando a recuperação dos dados mais eficiente e organizada.

Download Receivables by ID

Permite o download de recebíveis, garantindo que as informações detalhadas fiquem acessíveis para análise.

📌Endpoint

Método: POST
Endpoint: /receivables-download

Para este método, deve-se informar um ou mais IDs para que a API forneça o arquivo correspondente, garantindo que os dados sejam recuperados de forma segura.

Get All Issuers Distinct

Retorna uma lista de todos os emissores cadastrados na plataforma, permitindo que o usuário visualize as diferentes origens dos recebíveis disponíveis.

📌 Endpoint

Método: GET
Endpoint: /receivables/issuers

Esse método possibilita a identificação de emissores distintos, auxiliando na organização e categorização dos recebíveis.

Status

Status	Descrição
Disponível	Recebível disponível para receber propostas.
Expirado	A agenda passou do período para receber propostas.
Em Negociação	Aguardando o adquirente aceitar ou recusar oferta.
Negociado	Proposta aceita pelo adquirente e contrato inserido na plataforma.
Liquidado	Recebível liquidado.
Indisponível	Recebíveis zerados (não aparecem na visualização).
Reservado	Recebível que está dentro da margem de segurança.