¶ Integrar os Dados da Apuração Assistida
A rotina Integrações permite importar os dados da Apuração Assistida de CBS que foram disponibilizados pela consulta via API e estão armazenados nos arquivos baixados pela rotina automática.
¶ Painel de Integração
Além da execução direta pelos parâmetros descritos a seguir, a rotina Integrações conta com uma ação que abre o Painel de Integração, permitindo solicitar manualmente a integração dos dados de débitos de CBS e acompanhar o processamento das requisições. O painel é dividido em três abas:
- Solicitação: permite gerar manualmente uma nova requisição para obtenção dos débitos da Apuração Assistida.
- Processamento: permite acompanhar a situação das requisições, desde o envio até a disponibilização dos dados, incluindo as situações que necessitam de verificação.
- Integração: permite selecionar o período e integrar o último arquivo disponibilizado para a competência.
A rotina de integração automática, executada diariamente às 00h, permanece inalterada.
⚠️Atenção!
Devido à limitação de consultas da API da SERPRO, recomenda-se utilizar a solicitação manual (aba Solicitação) somente em situações excepcionais, quando não for possível aguardar a execução automática.
¶ Integração
Ao abrir a rotina, informe os seguintes parâmetros:
- Tipo Integração: Tipo do dado a ser integrado. Está disponível apenas a opção Débitos.
- Empresa: Empresa para a qual será efetuada a integração.
- Período: Mês e ano de referência para a integração.
Clique em Executar. O sistema localizará os arquivos previamente baixados pela rotina automática e realizará a integração dos dados de débitos da CBS para a base da empresa.
⚠️ Atenção!
Caso a empresa informada não possua credenciais cadastradas e ativas, o sistema exibirá uma mensagem orientando o usuário a realizar o cadastro antes de prosseguir.
No resultado do processo da integração, o sistema irá apresentar a data do último arquivo que foi efetuado o download com sucesso e caso a última requisição apresente algum alerta, o mesmo será sinalizado:
Para visualizar os detalhes, foi disponibilizada a ação Log da Última Requisição.
Ao acessá-la o sistema irá demonstrar o histórico da última requisição efetuada à Receita Federal, demonstrando a situação atual:
Lista de Logs mapeados:
-
Arquivo baixado para apuração da competência MM/AAAA. Disponível para integração: Arquivo da apuração foi disponibilizado pela receita e poderá ser integrado para o sistema.
-
Geração do token obtida com sucesso: as credenciais estão válidas e a API seguirá com a requisição.
-
Iniciando download: Download iniciado pela API interna.
-
Download disparado para início: Download disparado para início na API interna.
-
Download adicionado na fila: Download adicionado à fila da API interna.
-
Arquivo disponível para download: Receita Federal disponibilizou o arquivo para a API interna efetuar o download.
-
Solicitação de arquivo enviada para a Receita - Aguardando retorno: Requisição enviada para a Receita Federal, aguardando o retorno com o arquivo.
-
Requisição iniciada para a empresa (CNPJ: 00000000000000): Iniciado o processo da requisição de novo arquivo para a competência corrente.
-
Geração do token com falha - aguardando tempo de 0000s solicitado pela Receita: A Receita Federal possui limite de geração de tokens por hora/dia, o sistema irá fazer nova tentativa após o tempo apresentado.
-
Limite de requisições para geração de token excedido na Receita: A Receita Federal possui limite de geração de tokens por hora/dia, quando retornada essa mensagem, deverá aguardar a próxima execução automática.
-
Geração do token com falha - O CNPJ da empresa não corresponde às credenciais cadastradas. Verifique o cadastro das credenciais da empresa: O CNPJ não corresponde ao client_id e client_secret informados no cadastro. Precisa ser ajustado o cadastro no sistema e enviada a atualização das credenciais para a API (Utilizar ação Atualizar Credenciais).
-
Requisição manual iniciada para a empresa (CNPJ: 00000000000000): Iniciado o processo da requisição de novo arquivo para a competência corrente.
-
Última requisição pendente sem retorno da Receita - Iniciada nova requisição: Alerta sobre o início de uma nova requisição, quando a última não obteve retorno da Receita Federal.
-
Requisição manual recusada: Empresa com cadastro inativo. Verifique o cadastro das credencias e reative a empresa: Empresa está com cadastro Inativo e não irá seguir com a requisição.
Resultados esperados no processo de integração:
- "Nenhum arquivo disponível para essa competência. A competência informada (MM/AAAA) é superior à competência corrente (MM/AAAA).": Não é possível efetuar a integração de um período superior ao mês corrente.
- "Nenhum arquivo disponível para essa competência. O contribuinte foi cadastrado em MM/AAAA; não há apuração anterior a essa competência.": Não é possível efetuar a integração de um período anterior ao cadastro na API - Poderá ser integrado o mês corrente e o mês anterior, se o cadastro da empresa foi efetuado antes do fechamento do período de ajustes do mês anterior. Nesse caso, basta efetuar a integração do mês corrente.
- "Nenhum arquivo disponível para essa competência. A requisição à Receita (última em DD/MM/AAAA HH:MM) ainda não retornou um arquivo.": empresa cadastrada e ativa. A API Interna efetuou a requisição para a Receita Federal, porém a Receita Federal ainda não disponibilizou o arquivo para Download.
- “Processamento e gravação bem-sucedidos! Última atualização obtida em DD/MM/AAAA HH:MM.”: Integração efetuada com sucesso, informando a data/hora de devolução do último arquivo com sucesso.
- “Processamento e gravação bem-sucedidos! Última atualização obtida em DD/MM/AAAA HH:MM. Atenção: houve falha em tentativa mais recente (DD/MM/AAAA HH:MM). Para mais informações acesse o Log da Última Requisição.”: há um arquivo para integração disponível no período informado, porém a captura de um novo arquivo para o período corrente apresentou falha. Verificar o Log da Última Requisição para identificar o motivo.
- “Nenhum documento para importação foi retornado pela API no período informado.”: o arquivo foi disponibilizado pela Receita Federal, porém não possui documentos fiscais para integração - arquivo vazio. Verificar dados no portal da Apuração Assistida.
- “A empresa selecionada não possui configuração de credenciais válida para acesso à API da Apuração Assistida ou está inativa. Verifique as credenciais de acesso em: Áreas de Trabalho > Reforma Tributária > Apuração Assistida > Empresas - Credenciais da Apuração Assistida. clique aqui.”