Ir para o conteúdo
Método URL
POST https://BASE_URL/public/v1/recebiveis/lotes/{idLote}/enviar

Envia o lote para processamento no fundo.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.

Esta rota não possui Request Body.

Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "O lote foi enviado para processamento no fundo"
}

Erros

Erros retornam HTTP 400 Bad Request com o envelope RetornoPadrao.

Status do lote

O envio só é permitido quando o lote está no status Em Digitação (idStatus 1). Em qualquer outro status (por exemplo, Aguardando Envio, Enviado ao Fundo, Finalizado, Cancelado ou Rejeitado) a API rejeita a chamada. Consulte os valores possíveis em Status de Lote ou na tabela Status da consulta de lote.

Response Body — 400 Bad Request (status não permite o envio)
{
  "status": "erro",
  "mensagem": "O status atual do lote ('Enviado ao Fundo') não permite o envio ao fundo."
}

Lote sem títulos

O lote precisa ter ao menos um título vinculado. Um lote criado e ainda vazio — ou que teve todos os títulos removidos — é rejeitado antes de qualquer avanço de etapa, e permanece em Em Digitação. Adicione os títulos com Adicionar Títulos antes de chamar o envio.

Response Body — 400 Bad Request (lote sem títulos)
{
  "status": "erro",
  "mensagem": "O lote 987 não possui títulos e não pode ser enviado ao fundo."
}

Lote inexistente

Response Body — 400 Bad Request (lote inexistente)
{
  "status": "erro",
  "mensagem": "Não foi possível identificar o lote 987."
}

Modelo de dados

Retorno

Campo Tipo Descrição
status Texto Status do processamento.
mensagem Texto Mensagem retornada pela API.