Ir para o conteúdo
Método URL
https://BASE_URL/public/api/v1/valor-disponivel-movimentacao

Consulta o valor disponível para movimentação dos fundos numa data de referência: quanto o fundo tem disponível naquele dia para receber novas cessões.

É a consulta a fazer antes de montar um lote: ela diz o teto do que vale a pena enviar ao fundo na data. Um lote acima desse valor não é recusado por este endpoint — a verificação acontece no processamento do lote —, mas o envio tende a não ser aproveitado por inteiro.

Os resultados respeitam o RLS e ficam restritos ao grupo econômico do token informado no header GrupoEconomico.

Query Params

Todos os parâmetros são opcionais.

Parâmetro Tipo Descrição
dataReferencia Texto (date) Data-base da consulta. Formato YYYY-MM-DD. Quando omitida, assume a data atual.
idCessionario Número (long) Filtra por um financiador (fundo). Quando omitido, devolve todos os fundos ativos do grupo econômico.

Query parameters são case-insensitive (dataReferencia ou DataReferencia funcionam).

Request

Exemplo de querystring
GET https://BASE_URL/public/api/v1/valor-disponivel-movimentacao?dataReferencia=2026-03-20&idCessionario=12

Response

A resposta é sempre uma lista, mesmo quando idCessionario é informado (com um único item).

Response Body — 200 OK
[
  {
    "idCessionario": 12,
    "nome": "FIDC Exemplo",
    "cnpj": "12345678000190",
    "dataReferencia": "2026-03-20",
    "valorDisponivelMovimentacao": 1000000.00
  }
]

Modelo de dados

Campo Tipo Descrição
idCessionario Número (long) Identificador do financiador (fundo).
nome Texto Nome do fundo.
cnpj Texto CNPJ do fundo, somente dígitos.
dataReferencia Texto (date) Data a que o valor devolvido se refere — a data pedida na consulta.
valorDisponivelMovimentacao Número (decimal) Valor que o fundo tem disponível para movimentação na data de referência.

Códigos de retorno

Código Modelo Descrição
200 OK Lista de ValorDisponivelMovimentacaoDto Consulta realizada. Sem idCessionario, a lista pode vir vazia quando o grupo econômico não tem nenhum fundo ativo.
400 Bad Request RetornoPadrao Erro ao consultar o valor disponível para movimentação.
404 Not Found RetornoPadrao Só ocorre com idCessionario informado: o fundo não existe ou está inativo.

Com idCessionario informado, o fundo ausente é 404, não uma lista vazia com 200. Quem pede um fundo específico espera um número, e um [] com 200 convida a tratar a ausência como zero — e zero, aqui, significa "não envie nada".

Response Body — 404 Not Found
{
  "status": "erro",
  "mensagem": "Financiador 12 não encontrado ou inativo."
}