Consultar boletos em lote

Funcionalidade principal

Este endpoint oferece uma maneira eficiente de consultar o status de múltiplos boletos de uma só vez, sendo a ferramenta ideal para conciliação e automação de processos em lote.

A consulta é realizada dentro de um período específico, definido pelos campos DataInicial e DataFinal. Além do intervalo de datas, a busca pode ser refinada por:
TipoPesquisa: Define qual data será usada como referência no filtro (ex: DataEmissao, DataVencimento ou DataPagamento).
StatusPesquisa: Permite filtrar boletos por um status específico (ex: Pendentes, Pagos, Vencidos).

Casos de uso comuns

Realizar a conciliação financeira de todos os boletos pagos em um determinado dia.

Automatizar a liberação de pedidos buscando em lote por boletos que mudaram de status para "Pago".

Gerar relatórios de inadimplência, buscando por boletos vencidos em um certo período.

Nota importante sobre automação: Conforme mencionado no endpoint de consulta individual, este é o método recomendado para implementar a automação de status via polling. Realizar uma única chamada em lote é significativamente mais performático do que consultar cada boleto individualmente.

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

curl --location '/api/CashIn/ConsultarBoletoLote' \ --header 'UserName;' \ --header 'RequestOrigin;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Data": { "CodigoCanal": 0, "CodigoCliente": 0, "DataInicial": "2019-08-24T14:15:22.123Z", "DataFinal": "2019-08-24T14:15:22.123Z", "TipoPesquisa": "DataEmissao", "StatusPesquisa": 0 } }'

{ "Data": [ { "Status": "string", "Valor": 0, "ValorPago": 0, "ValorJuros": 0, "ValorMulta": 0, "DataGeracao": "string", "DataVencimento": "string", "DataPagamento": "string", "OrigemBoleto": "string", "NossoNumero": "string", "LinhaDigitavel": "string", "CodigoBarras": "string", "IdentificadorCliente": "string", "DadosPagador": { "CpfCnpj": 0, "Nome": "string", "Endereco": "string", "Bairro": "string", "Cidade": "string", "Cep": "string", "Uf": "string", "DdiTerceiro": 0, "DddTerceiro": 0, "NumeroCelularTerceiro": 0 } } ], "ResultCode": 0, "Message": "string", "ValidationData": { "ResultCode": 0, "Message": "string", "Errors": [ { "ErrorMessage": "string", "FieldName": "string" } ] } }

Funcionalidade principal

Casos de uso comuns

Requisição

Respostas

Consultar boletos em lote

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns