Acompanhamento de boletos - API

 Módulo: Financeiro > Consultas             Versão disponível: A partir da 4.18

Serão apresentados nesta tela os registros dos boletos gerados pela API do banco. Desse modo, você poderá obter informações do boleto, como, por exemplo, sua emissão, alteração, cancelamento, entre outros.

Esta tela será disponibilizada automaticamente aos usuários que possuem permissão de acesso às telas Geração Arquivo de Remessa, Processamento do Arquivo de Retorno ou Contas. Além disso, o usuário, com essa permissão, poderá conceder aos demais usuários o acesso a esta tela normalmente. 

Para saber como gerar os boletos via API do banco em nossa solução, acesse o artigo Boleto rápido API.

Você pode conferir os registros dos boletos de forma mais rápida, para isso, configure os filtros na parte esquerda da tela.

Inicialmente no campo "Status do Boleto", acione o tipo de busca dos registros dos boletos, conforme as alternativas abaixo: 

• abertos;
• agendados;
• cancelados;
• liquidados;
• protestado;
• não registrados. 

Ao acionar a marcação "Não registrados", serão apresentados os boletos gerados no Sankhya Om, mas que não foram registrados no banco. 

Além disso, é possível que você filtre os boletos considerando o "Nro Único", o "Nro Nota", o "Nosso Número", "Parceiro", a "Data de Vencimento" e a "Data de Emissão".

Pode-se também realizar a busca dos boletos adicionando o banco e/ou a conta bancária na seção "Banco" e "Conta Bancária", respectivamente.

Feito isso, clique em "Aplicar" para que os registros sejam exibidos no painel. 

Grade Boletos

Com as configurações acima realizadas, na grade Boletos serão exibidos os seguintes dados do boleto:

Histórico do Boleto

Ao selecionar um registro na grade Boletos, na grade inferior você poderá verificar as informações sobre o Histórico do Boleto, por meio dos campos abaixo.

No campo "Tipo Evento" analise qual o tipo de evento do boleto, isto é: 

• emissão;
• alteração;
• baixa/cancelamento;
• retorno recebido do banco;

Verifique no campo "Data Evento" a data e o horário que foi realizado o evento.

No campo "Descrição do Evento" você pode conferir o detalhamento do evento, por exemplo:

• emissão de boleto enviada para o banco;
• alteração de boleto enviada para o banco;
• baixa/cancelamento de boleto enviada para o banco;
• retorno recebido do banco.

Por meio do campo "Situação" é exibido o status da solicitação, podendo ser:

• processada: a solicitação foi processada pelo banco com sucesso.
• pendente de envio: a solicitação está pendente de envio para o banco. Abaixo temos alguns exemplos de situações em que um evento poderá ficar Pendente de Envio:
  • solicitação de alteração ou cancelamento do boleto que foi registrado com menos de 30 minutos;
  • erro de comunicação com API;
  • job de envio não foi executado.
• rejeitada: a solicitação não foi acatada pelo banco. 

No campo "Retorno do Banco" você pode verificar o status de retorno obtido pelo banco, como, por exemplo:

• status 200: Executado com sucesso;
• status 201: Criado com sucesso;
• status 404: Requisição não encontrada;
• status 500: Erro interno do Servidor.

Você também pode conferir por meio do campo "Status do Boleto" a situação do boleto. Na imagem abaixo confira as classificações dos status dos boletos:

Tabela Histórico de Boleto API - TGFHBA

Para acompanhar o histórico dos boletos API, temos a tabela TGFHBA. A seguir, conheça as siglas desta tabela:

Status do título (STATUS):

• A - Aguardando envio: ainda não foi enviado para a API;
• E - Enviada: já foi enviada para a API e para o banco;
• B - Baixada: financeiro foi baixado no sistema (pago);
• P - Processada: já foi enviado para a API, porém, ainda não consultou o status para o banco;
• R - Renegociada: foi renegociado no sistema;
• X- Título Excluído: foi excluído do sistema.

Status de envio para o banco (STATUSENVIO):

• A - Aguardando envio: ainda não foi enviado para a API;
• P - Processada: já foi enviado para a API, no entanto, ainda não consultou o status para o banco;
• E - Enviada: já foi enviada para a API e para o banco.

Status que o título se encontra no banco (STATUSBANC): 

• 0 - Ainda não registrado;
• 1 - Normal;
• 2 - Movimento cartório;
• 3 - Em cartório;
• 4 - Titulo com ocorrência cartório;
• 5 - Protestado eletrônico;
• 6 - Liquidado;
• 7 - Baixado pelo banco;
• 8 - Titulo com pendência no cartório;
• 9 - Titulo protestado manualmente;
• 10 - Titulo baixado pago em cartório;
• 11 - Titulo liquidado protestado;
• 12 - Titulo liquidado em cartório;
• 13 - Titulo protestado aguardando baixa;
• 14 - Titulo em liquidação;
• 15 - Titulo agendado bb;
• 16 - Titulo creditado;
• 17 - Pago em cheque aguardando liquidação;
• 18 - Pago parcialmente;
• 19 - Pago parcialmente creditado;
• 21 - Titulo agendado outros bancos.

Tipo de envio (TIPOENVIO):

• A - Alteração;
• B - Baixa;
• E - Entrada;
• X - Exclusão.