Consulta e Liquidação via API (PIX e Boleto)
Consulta e Liquidação via API (PIX e Boleto)
Esta rotina permite consultar os recebimentos de PIX e de boletos informados pelo banco e liquidar os títulos correspondentes.
Visão Geral
Esta rotina permite consultar os recebimentos de PIX e de boletos informados pelo banco e liquidar os títulos correspondentes. Você pesquisa os recebimentos por período, nosso número ou situação, seleciona os que deseja, confere os títulos, e o sistema faz a liquidação, gera as movimentações financeiras e contábeis e apresenta o comprovante. Também é possível sincronizar os boletos híbridos (boleto com PIX) antes da consulta.
Onde encontrar: Financeiro › Cobrança › Consulta e Liquidação via API (PIX e Boleto)
O que você pode fazer aqui
Pesquisar os recebimentos _(ref.: [GET] /ConsultaLiquidacaoPIXBoleto/ListarRecebimentosPIXBoletosAPI)_
Como usar
- Entre no sistema logado em uma carteira. Sem carteira selecionada a rotina não abre.
- Abra a rotina pelo menu Financeiro › Cobrança.
- Na seção Pesquisa, informe os filtros desejados.
- Clique em Buscar. Os recebimentos encontrados aparecem na lista.
Campos
| Campo | O que informar / mostrar |
|---|---|
| Filtro | Define o tipo de consulta. |
| Dt. Emissão (até) | Período de emissão dos títulos. |
| Dt. Vencimento (até) | Período de vencimento dos títulos. |
| Nosso Número | Número de identificação do título no banco. |
| Listar apenas liquidados | Quando marcado, limita a lista aos recebimentos já liquidados. |
Campos exibidos na lista
| Campo | O que mostra |
|---|---|
| Nosso Número | Número do título no banco. |
| Nº Título | Número do título no sistema. |
| Data de Emissão, Data de Vencimento e Data de Pagamento | Datas do título e do pagamento. |
| Valor Título, Valor Líquido e Valor Pago | Valores do título e do que foi pago. |
| Valor Juros, Valor Multa, Valor Desconto e Valor Acréscimo | Valores adicionais do recebimento. |
| Ocorrência e Descrição da Ocorrência | Ocorrência informada pelo banco. |
| Ocorrência de Crítica | Indica se há crítica no título. |
| Participante | Cliente do título. |
| Filial | Filial do título. |
Regras importantes
- A consulta é feita para a carteira em que você está logado.
- Se algum campo do filtro estiver incorreto, o sistema pede que você preencha todos os campos corretamente.
Sincronizar boletos híbridos _(ref.: [POST] /ConsultaLiquidacaoPIXBoleto/ExecutarSincronizacaoDeBoletoHibrido)_
Como usar
- Na janela “Parâmetros para Sincronização”, informe os dados solicitados e clique em Ok.
- O sistema exibe “Executando a Sincronização de Boleto Híbrido”.
- Ao final, aparece a mensagem “Sincronização Realizada com Sucesso!”.
Regras importantes
- O serviço de processamentos do sistema precisa estar em execução.
Adicionar os itens selecionados ao lote _(ref.: [POST] /ConsultaLiquidacaoPIXBoleto/ProcessarItensSelecionados)_
Como usar
- Marque na lista os recebimentos que deseja liquidar.
- Confirme a pergunta “Liquidação — Adicionar Itens Selecionados ao Lote?”.
- O sistema acumula os itens no lote e, quando houver críticas, apresenta a janela de críticas e disponibiliza o arquivo com o texto das críticas.
Regras importantes
- É obrigatório selecionar ao menos um item.
- Confira as críticas antes de liquidar: títulos com crítica podem não ser liquidados.
Liquidar os títulos _(ref.: [POST] /ConsultaLiquidacaoPIXBoleto/Salvar)_
Como usar
- Com os itens no lote, abra a janela de confirmação dos títulos e confira os dados.
- Informe se deseja “Agrupar lançamentos do módulo Banco ?”.
- Confirme a liquidação.
- O sistema liquida os títulos, gera as operações financeiras e contábeis e exibe o comprovante.
Campos do comprovante
| Campo | O que mostra |
|---|---|
| Data da operação e Código da operação | Identificação da liquidação. |
| Total Liquidado | Valor total liquidado. |
| (+) Juros, (-) Desconto, (+) Acréscimo, (-) Decréscimo, (+) Multa e (-) Tarifa | Composição do valor liquidado. |
| Operações Financeiras e Operações Contábeis | Abas com os lançamentos gerados. |
Regras importantes
- Os títulos liquidados passam para a situação Liquidado.
- A liquidação gera a movimentação financeira e a integração contábil na mesma operação.
Imprimir o comprovante _(ref.: [POST] /ConsultaLiquidacaoPIXBoleto/Imprimir)_
Como usar
Após a liquidação, use Gerar PDF, ou Exportar Excel ou Word, para obter o comprovante.
Erros mais comuns e como resolver
Nenhuma carteira selecionada
Mensagem exibida: Atenção: Nenhuma carteira está selecionada. Para acessar esta rotina, é necessário estar logado em uma carteira.
Como resolver: Entre no sistema selecionando uma carteira e abra a rotina novamente.
Carteira não selecionada na consulta
Mensagem exibida: Consulta não realizada — Obrigatório selecionar a carteira no menu financeiro!
Como resolver: Selecione a carteira no menu financeiro e consulte novamente.
Pesquisa inválida
Mensagem exibida: Pesquisa inválida. — Preencha todos os campos corretamente !
Como resolver: Revise os filtros informados e tente novamente.
Nenhum registro encontrado
Mensagem exibida: Nenhum registro encontrado para o filtro informado.
Como resolver: Ajuste os filtros (período, nosso número) e consulte novamente.
Nenhum item selecionado
Mensagem exibida: Erro — Nenhum item selecionado.
Como resolver: Marque ao menos um recebimento na lista.
Nenhum título para liquidação
Mensagem exibida: Aviso — Nenhum Título para liquidação!
Como resolver: Adicione itens ao lote antes de liquidar.
Serviço de processamentos parado
Mensagem exibida: O Serviço de processamentos não esta sendo executado. Verifique o serviço em Customização local > Serviços do sistemas.
Como resolver: Inicie o serviço de processamentos e execute a sincronização novamente.
Falha na sincronização
Mensagem exibida: Erro — Erro ao executar a Sincronização.
Como resolver: Verifique os parâmetros e tente novamente. Persistindo, acione o suporte.
Falha ao buscar os registros
Mensagem exibida: Erro — Não foi possível buscar os registros.
Como resolver: Tente novamente; se continuar, confirme com o administrador o acesso e a integração com o banco.
Configurações e permissões necessárias
| ID | Nome |
|---|---|
| 4316 | Tela Consulta e Liquidação via API (PIX e Boleto) (EditViewDeConsultaLiquidacaoPIXBoletoAPI) |
| 4338 | ConsultaLiquidacaoPIXBoleto/Salvar |
| 4339 | ConsultaLiquidacaoPIXBoleto/Imprimir |
É necessário estar logado em uma carteira e ter a integração com o banco configurada. A rotina fica dentro do menu Cobrança (ID 1562).
Por que usar esta rotina
- Liquida PIX e boletos recebidos sem digitar baixa a baixa.
- Mostra as críticas antes da liquidação.
- Gera movimentação financeira, contabilização e comprovante na mesma operação.