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.

O lote precisa estar em Em Digitação (idStatus 1) e ter ao menos um título vinculado. Um lote de liquidação ainda vazio é rejeitado antes de qualquer avanço de etapa e permanece em Em Digitação — adicione as liquidações com Adicionar Liquidações 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."
}
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."
}

Modelo de dados

Retorno

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