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

Adiciona uma ou mais liquidações a um lote existente.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.
Request Body
{
  "liquidacoes": [
    {
      "numeroControleParticipante": "0001",
      "numeroDocumento": "12345",
      "dataLiquidacao": "2024-11-15T18:25:43.511Z",
      "valorPago": 1000
    }
  ]
}
Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "1 registros atualizados com sucesso."
}

Modelo de dados

Requisição

Campo Tipo Descrição
liquidacoes Lista de Liquidação Lista de liquidações a serem adicionadas ao lote.

Liquidação

Campo Tipo Descrição
numeroControleParticipante Texto Número de controle do participante.
numeroDocumento Texto Número do documento.
dataLiquidacao Data/Hora Data e hora da liquidação.
valorPago Decimal Valor pago na liquidação.

Retorno

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