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

Consulta o resultado de títulos vinculados a um lote específico.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.
Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "Consulta realizada com sucesso.",
  "titulos": [
    {
      "regra": "Documento inválido",
      "quantidadeOcorrencia": 1,
      "numeroDocumento": "DOC-874521",
      "dataEmissao": "2025-03-12",
      "dataVencimento": "2025-11-28",
      "valorNominal": 1842.35,
      "especie": 2,
      "documentoSacado": "41830562890"
    }
  ]
}

Modelo de dados

Retorno

Campo Tipo Descrição
status Texto Status do processamento.
mensagem Texto Mensagem retornada pela API.
titulos Lista de Título Lista de títulos retornada pela consulta.

Título

Campo Tipo Descrição
regra Texto Regra associada ao título, quando houver.
quantidadeOcorrencia Número Quantidade de ocorrências da regra.
numeroDocumento Texto Número do documento.
dataEmissao Data Data de emissão do título.
dataVencimento Data Data de vencimento do título.
valorNominal Decimal Valor nominal do título.
especie Número Código da espécie do título.
documentoSacado Texto Documento do sacado.