ACBrBoleto BTG Pactual API Como fazer a consulta em lista (TpConsulta)

[Daniel InfoCotidiano]

Filtro de pesquisa para o Banco BTG Pactual.

Delphi / Lazarus:

Atenção:
O Campo marcado com asterisco (*) é Obrigatório, sendo assim os demais são opcionais.
Índice de continuidade é a paginação, quando necessário mais de uma consulta para o restante dos títulos.

  FiltrosAPI := Boleto.Configuracoes.WebService.Filtro;
  FiltrosAPI.Clear;
* FiltrosAPI.indicadorSituacao          := isbAberto; (Disponiveis:  isbAberto, isbBaixado ou isbCancelado) 

  FiltrosAPI.dataRegistro.DataInicio := strtodate('01/04/2025');
  FiltrosAPI.dataRegistro.DataFinal  := strtodate('02/04/2025');

  FiltrosAPI.dataMovimento.DataInicio := strtodate('01/04/2025');
  FiltrosAPI.dataMovimento.DataFinal  := strtodate('02/04/2025');

  FiltrosAPI.dataVencimento.DataInicio := strtodate('01/04/2025');
  FiltrosAPI.dataVencimento.DataFinal  := strtodate('02/04/2025');

  FiltrosAPI.indiceContinuidade       := 0;

Atenção, o envio das consultas deve ser realizado pelo parâmetro: TpConsulta

Boleto.Configuracoes.WebService.Operacao := tpConsulta;

Exemplos:
Consultar lista dos títulos em Aberto (sem exibir os boletos vencidos), Registrados no período 04/04/2025 até 10/04/2025:

  FiltrosAPI := Boleto.Configuracoes.WebService.Filtro;
  FiltrosAPI.Clear;
* FiltrosAPI.indicadorSituacao          := isbAberto;
  FiltrosAPI.dataRegistro.DataInicio    := strtodate('04/04/2025');
  FiltrosAPI.dataRegistro.DataFinal     := strtodate('10/04/2025');
  FiltrosAPI.indiceContinuidade         := 0;

Consultar lista dos títulos em cancelados, com vencimento no período 01/04/2025 até 05/04/2025:

  FiltrosAPI := Boleto.Configuracoes.WebService.Filtro;
  FiltrosAPI.Clear;
* FiltrosAPI.indicadorSituacao          := isbCancelado;
  FiltrosAPI.dataVencimento.DataInicio  := strtodate('01/04/2025');
  FiltrosAPI.dataVencimento.DataFinal   := strtodate('05/04/2025');
  FiltrosAPI.indiceContinuidade         := 0;

Consultar lista dos títulos Liquidados, com data movimento (liquidação) no período 01/04/2025 até 10/04/2025:

  FiltrosAPI := Boleto.Configuracoes.WebService.Filtro;
  FiltrosAPI.Clear;
* FiltrosAPI.indicadorSituacao          := isbBaixado;
  FiltrosAPI.dataMovimento.DataInicio  := strtodate('01/04/2025');
  FiltrosAPI.dataMovimento.DataFinal   := strtodate('10/04/2025');
  FiltrosAPI.indiceContinuidade         := 0;

ACBrLibBoleto:

Atenção:

É necessário incluir um titulo na lista de títulos antes do envio da consulta.
O Campo marcado com asterisco (*) é Obrigatório, sendo assim os demais são opcionais.
Índice de continuidade é a paginação, quando necessário mais de uma consulta para o restante dos títulos.

  [ConsultaAPI]
* IndicadorSituacaoBoleto    = 1
  BoletoVencido              = 0
  contaCaucao                = 
  cnpjCpfPagador             = 
  codigoEstadoTituloCobranca = 
  carteira                   = 
  modalidadeCobranca         = 

  DataInicioRegistro   = 01/04/2025
  DataFinalRegistro    = 02/04/2025

  DataInicioMovimento  = 01/04/2025
  DataFinalMovimento   = 02/04/2025

  DataInicioVencimento = 01/04/2025
  DataFinalVencimento  = 02/04/2025

  FiltrosAPI.indiceContinuidade = 0

Atenção, o envio das consultas deve ser realizado pelo parâmetro: TpConsulta

Boleto_EnviarBoleto(3, sResposta, esTamanho);

Exemplos:
Consultar lista dos títulos em Aberto (sem exibir os boletos vencidos), Registrados no período 04/04/2025 até 10/04/2025:

  [ConsultaAPI]
* indicadorSituacao     := isbAberto
  boletoVencido         := 1
  DataInicioRegistro    := 04/04/2025
  DataInicioRegistro    := 10/04/2025
  indiceContinuidade    := 0

Consultar lista dos títulos cancelados, com vencimento no período 01/04/2025 até 05/04/2025:

  [ConsultaAPI]
* indicadorSituacao     := 3
  DataInicioVencimento  := 01/04/2025
  DataFinalVencimento   := 05/04/2025
  indiceContinuidade    := 0

Consultar lista dos títulos Liquidados, com data movimento (liquidação) no período 01/04/2025 até 10/04/2025:

  [ConsultaAPI]
* indicadorSituacao  : 1
  DataInicioMovimento: 01/04/2025
  DataFinalMovimento : 10/04/2025
  indiceContinuidade : 0

ACBrMonitorPlus:

Atenção:
O Campo marcado com asterisco (*) é Obrigatório, sendo assim os demais são opcionais.
Índice de continuidade é a paginação, quando necessário mais de uma consulta para o restante dos títulos.

  BOLETO.ConsultarTitulosPorPeriodo("[ConsultaAPI]
* IndicadorSituacaoBoleto    = 1

  DataInicioRegistro   = 01/04/2025
  DataFinalRegistro    = 02/04/2025

  DataInicioMovimento  = 01/04/2025
  DataFinalMovimento   = 02/04/2025

  DataInicioVencimento = 01/04/2025
  DataFinalVencimento  = 02/04/2025

  FiltrosAPI.indiceContinuidade = 0")

Exemplos:
Consultar lista dos títulos em Aberto (sem exibir os boletos vencidos), Registrados no período 04/04/2025 até 10/04/2025:

  BOLETO.ConsultarTitulosPorPeriodo("[ConsultaAPI]
* indicadorSituacao     := 1
  DataInicioRegistro    := 04/04/2025
  DataInicioRegistro    := 10/04/2025
  indiceContinuidade    := 0")

Consultar lista dos títulos Baixados, com vencimento no período 01/04/2025 até 05/04/2025:

  BOLETO.ConsultarTitulosPorPeriodo("[ConsultaAPI]
* indicadorSituacao     := 2
  DataInicioVencimento  := 01/04/2025
  DataFinalVencimento   := 05/04/2025
  indiceContinuidade    := 0")

Consultar lista dos títulos Liquidados, com data movimento (liquidação) no período 01/04/2025 até 10/04/2025:

  BOLETO.ConsultarTitulosPorPeriodo("[ConsultaAPI]
* indicadorSituacao  : 3
  DataInicioMovimento: 01/04/2025
  DataFinalMovimento : 10/04/2025
  indiceContinuidade : 0")