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

O envio só é permitido quando o lote está no status Aguardando Envio (idStatus 4). Em qualquer outro status (por exemplo, Em Digitação, 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.

Erros retornam HTTP 400 Bad Request com o envelope RetornoPadrao.

Response Body — 400 Bad Request (status não permite o envio)
{
  "status": "erro",
  "mensagem": "O status atual do lote ('Em Digitação') não permite o envio ao fundo."
}
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.