Consulta e Liquidação via API (PIX)
Consulta e Liquidação via API (PIX)
Esta rotina permite consultar os PIX recebidos informados pelo banco em um período e liquidar os títulos a receber correspondentes.
Visão Geral
Esta rotina permite consultar os PIX recebidos informados pelo banco em um período e liquidar os títulos a receber correspondentes. Você pesquisa por data, seleciona os PIX desejados, o sistema aponta críticas (PIX que não puderam ser vinculados a um título), e então liquida os títulos, gera a remessa de baixa, as movimentações financeiras e contábeis e o comprovante.
Onde encontrar: Financeiro › Cobrança › Consulta e Liquidação via API (PIX)
O que você pode fazer aqui
Pesquisar os PIX recebidos _(ref.: [GET] /ConsultaPIXRecebidos/ListarRecebidosAPIPIX)_
Como usar
- Entre no sistema logado em uma carteira.
- Abra a rotina pelo menu Financeiro › Cobrança.
- Na seção Pesquisa, informe a Data inicial e a Data final.
- Clique em Buscar. Os PIX recebidos aparecem na lista; é possível ordenar pelas colunas.
Campos
| Campo | O que informar / mostrar |
|---|---|
| Data inicial e Data final | Período dos PIX recebidos. Sem as duas datas a lista não é carregada. |
| CNPJ/CPF | Documento do pagador. |
| Pagador | Nome de quem pagou o PIX. |
| Data do Pagamento | Data em que o PIX foi recebido. |
| Valor | Valor recebido. |
| Detalhes | Abre a janela “Detalhes do PIX” com as informações completas do recebimento. |
Adicionar os PIX selecionados ao lote _(ref.: [POST] /ConsultaPIXRecebidos/ProcessarPIXSelecionados)_
Como usar
- Marque na lista os PIX que deseja liquidar (ou use a opção de buscar todos os registros do filtro).
- Confirme a pergunta “Liquidação — Adicionar Itens Selecionados ao Lote?”.
- O sistema acumula os itens e informa “[quantidade] Registro(s) adicionado(s).”.
- O sistema vincula cada PIX ao seu título. Os que não puderem ser vinculados aparecem na janela de Críticas.
Campos da janela de críticas
| Campo | O que mostra |
|---|---|
| CNPJ/CPF e Pagador | Quem realizou o PIX. |
| Data do Pagamento e Valor | Data e valor do PIX. |
| Descrição do Erro | Motivo pelo qual o PIX não foi vinculado a um título. |
| Detalhes | Abre a janela “Detalhes da Critica do PIX”. |
Conferir e liquidar os títulos _(ref.: [POST] /ConsultaPIXRecebidos/Salvar)_
Como usar
- Na janela de confirmação, confira os títulos: Nº Título, Data Vencimento, Participante, Valor Título, Valor Pago e Detalhes.
- Informe se deseja “Agrupar lançamentos do módulo Banco ?”.
- Confirme a liquidação.
- O sistema cria a remessa de baixa, gera o arquivo, liquida os títulos e exibe o comprovante.
Campos do comprovante
| Campo | O que mostra |
|---|---|
| Data da operação, Código da operação e Documento | 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 (lançamento, filial, título, débito, crédito, histórico e valor). |
Regras importantes
- A liquidação gera uma remessa de baixa na carteira em que você está logado e tenta gerar o arquivo de remessa na pasta padrão de arquivos do financeiro.
- Se a remessa de baixa for criada, mas o arquivo não puder ser gerado, o sistema avisa e a liquidação continua.
- A movimentação financeira e a integração contábil são geradas na mesma operação.
Imprimir o comprovante _(ref.: [POST] /ConsultaPIXRecebidos/Imprimir)_
Como usar
Após a liquidação, solicite a impressão ou exporte para Excel. O sistema prepara o comprovante padrão com as movimentações geradas.
Erros mais comuns e como resolver
Nenhum título para liquidar
Mensagem exibida: Não será possível concluir a operação, pois não há títulos para serem liquidados
Como resolver: Selecione ao menos um PIX com título vinculado e tente novamente.
Erro ao criar a remessa de baixa
Mensagem exibida: Erro ao executar esta operação. — Erro ao Criar a Remessa de Baixa: [detalhe].
Como resolver: Verifique o motivo do erro e tente novamente.
Remessa criada com erro
Mensagem exibida: Erro ao executar esta operação. — A Remessa de Baixa Nº: [número] foi criada, porém ocorreu um erro na operação. [detalhe].
Como resolver: Verifique o motivo do erro e realize os ajustes necessários.
Nenhum PIX listado
Mensagem exibida: não há mensagem; a lista fica vazia.
Como resolver: Confirme se as duas datas foram informadas e se o período possui PIX recebidos.
Configurações e permissões necessárias
| ID | Nome |
|---|---|
| 4078 | Tela Consulta e Liquidação via API (PIX) (EditViewDeTitulosAReceberParaLiquidacaoPIX) |
| 4079 | ConsultaPIXRecebidos/Salvar |
| 4109 | ConsultaPIXRecebidos/ProcessarPIXSelecionados |
| 4110 | ConsultaPIXRecebidos/Imprimir |
É necessário estar logado em uma carteira, ter a integração PIX com o banco configurada e ter cadastrado e ativo o fato contábil da liquidação de título a receber (variação PIX). A rotina fica dentro do menu Cobrança (ID 1562).
Por que usar esta rotina
- Liquida os títulos pagos via PIX sem baixa manual.
- Aponta os PIX que não foram identificados antes de liquidar.
- Gera remessa de baixa, movimentações e comprovante na mesma operação.