Integração Compliance NFC-e

Última atualização em: 06 de janeiro, 2020

Olá! Nesse artigo iremos explicar sobre a integração com a API para enviar as conciliações ao InvoiCy.

Para facilitar seu entendimento também criamos uma documentação de integração com o Postman, para acessá-la clique aqui.

Por questões de segurança, é necessário gerar um token para integração com a API.

1. Como gerar o token de segurança para o compliance NFC-e:

O token a ser utilizado nas requisições do compliance NFC-e deve ser gerado da seguinte forma:

{{ host-invoicy }} – o host do invoicy
{{ pk }} – chave de parceiro (partner-key)
{{ ck }} – Hash MD5 da chave de acesso com o corpo da requisição md5(chaveAcesso + body)
{{ cnpj  }} – CNPJ da empresa que quer gerar o token
{{ extensao }} – nome da extensão que se deseja o token (nesse caso ‘compliance-nfce’)

O tipo da resposta será: Content-Type: application/json

2. Como agendar a conciliação:

O cliente poderá fazer o agendamento da conciliação utilizando o token da seguinte forma:

{{ access-token }} – token gerado no passo 1
{{ pk }} – chave de parceiro (partner key)
{{ cnpj-raiz }} – CNPJ raiz da empresa
{{ data-inicial }} – data inicial do período a ser conciliado (YYYY-MM-DD)
{{ data-final }} – data final do período a ser conciliado (YYYY-MM-DD)
{{ modelo }} – modelo do documento (nfce)
{{ fuso }} – Fuso horário de onde está fazendo a requisição, ex: -0300 || -03:00

O tipo da resposta será: Content-Type: application/json

3. Como enviar documentos para conciliação:

O cliente terá 10 minutos para enviar o documento a ser conciliado, após esses 10 minutos o processo de conciliação será executado para o agendamento, se o cliente não enviar o documento antes dos 10 minutos será necessário repetir o passo 2.

  • O conteúdo do documento deve seguir a seguinte regra:

* Campos obrigatórios

– Para cada empresa:

1                            2

99999999999999|51d19cb4cfba20398cc3ff20b091f243

1 – CNPJ *
2 – hashMD5(cnpj + chaveAcesso) *

– Para cada documento:

1         2     3    4                 5                                                                                       6

99999|999|99|9999-99-99|99999999999999999999999999999999999999999999|S

1 – Número *
2 – Série *
3 – Modelo *
4 – Data de emissão (YYYY-MM-DD) *
5 – Chave de acesso (em caso de inutilização, não é necessário informar)
6 – Documento cancelado/inutilizado (S – sim)

Os dados devem ser separados por | (pipe)

Exemplo do conteúdo:

O documento deve ser um arquivo de texto (.txt) compactado (.zip) e enviado da seguinte forma:

{{ url }} – url recebida no passo 2
@documento.zip – arquivo binário

Retorno da requisição com status 200 em caso de sucesso.

4. Como consultar a conciliação:

A conciliação poderá ser consultada da seguinte forma:

{{ protocolo }} – Protocolo recebido no agendamento da conciliação
{{ access-token }} – token gerado no passo 1

Os retornos possíveis na consulta da conciliação seguem:

{{ url-divergencias }} – url contendo um arquivo com todas divergências da conciliação.

O conteúdo do arquivo de divergências será um arquivo de texto (.txt) no seguinte formato:

1                           2         3     4   5 6

99999999999999|99999|999|99|9|9

1 – CNPJ
2 – Número
3 – Série
4 – Modelo
5 – Status do documento InvoiCy
6 – Status do documento Cliente

Exemplo de retorno:

  • Status do documento

1 – INCONSISTENTE
0 – FALTANTE
2 – AUTORIZADO
3 – REJEITADO
5 – CANCELADO
6 – INUTILIZADO

{{ cnpjs-processados }}quantidade de CNPJ’s já processados (integer)

 {{ erro-conciliacao }} – mensagem informando qual o erro que ocorreu (string)

{{ data-processamento }} – data e hora do processamento (YYYY-MM-DDTHH:mm:ss.SSSZ)

Extensão InvoiCy Compliance NFC-e

Última atualização em: 03 de agosto, 2020

Olá! Nesse artigo iremos explicar sobre a extensão ‘InvoiCy Compliance NFC-e’, que permite ao usuário comparar os dados gerados pelo Aplicativo Comercial do seu PDV com aqueles emitidos e armazenados no InvoiCy, possibilitando assim identificar eventuais inconsistências com o fisco.

As inconsistências existentes ainda serão exibidas em gráficos e relatórios gerenciais, assim a sua empresa garante o compliance dos documentos de NFC-e e minimiza os riscos na hora de enviar seu SPED FISCAL.

O acesso para ativar a extensão pode ser realizado por meio dos atalhos disponibilizados na janela Extensões, localizado na parte superior direita da aplicação, como demonstrado no artigo Extensões do InvoiCy.

Na tela de extensões, ao clicar sobre a imagem relacionada ao InvoiCy Compliance NFC-e, abrirá uma nova tela contendo a aba ‘Visão geral’, que apresentará uma breve explicação sobre a extensão, com imagens de demonstração das telas.

Já na aba ‘Ativação’, como demonstra a imagem a seguir, serão apresentadas as empresas que o usuário tem acesso, podendo ativar ou desativar o uso da extensão. Também nessa tela o usuário poderá configurar para que a extensão seja ativada automaticamente no momento do cadastro de uma nova empresa, para isso, basta marcar a opção ‘Ativar automaticamente’. Também é possível ativar a extensão para todas as empresas já cadastradas, selecionando a opção ‘Ativar empresas listadas’.

Ao selecionar uma ou mais das empresas listadas a extensão já será ativada para as mesmas, e a aba ‘Ativação’ passará a se chamar ’Configurações’, permitindo ativar ou desativar o serviço para outras empresas sempre que necessário.

Também será apresentado um novo ícone na parte superior direita da aplicação, como demonstra a imagem a seguir. Através desse ícone é possível acessar a nova tela do InvoiCy Compliance NFC-e.

Agora que você já conhece a extensão e sabe como ativá-la, o passo seguinte é fazer a integração com a API para enviar as conciliações ao InvoiCy. Para saber o passo a passo que deve ser executado, e visualizar os modelos de integração leia a documentação Integração InvoiCy Compliance NFC-e.

Após fazer a integração e enviar os arquivos para conciliação, na tela Compliance NFC-e será exibido o gráfico com o agrupamento de todas as conciliações, apresentando os CNPJs por dia que estão em conformidade ou não, de acordo com o período do mês selecionado, sendo atualizado conforme cada conciliação realizada.

Ao clicar no ícone que está posicionado do lado direito do gráfico, será exibida uma lista com os agendamentos das conciliações. O período para exibição dos registros é de até 3 meses. Poderá exibir as conciliações que retornaram inconsistência ou não, utilizando o filtro ‘Ocorrências’. E também poderá filtrar pelo status da conciliação, através da opção ‘Situação’.

Quando houver ocorrências e a conciliação estiver processada, o usuário poderá fazer download dos relatórios, que poderá ser simplificado ou detalhado, no formato .PDF ou .XLS, para visualizar as devidas ocorrências.

O relatório simplificado possibilita ao cliente identificar de forma rápida quais divergências ocorreram nas conciliações enviadas, exibindo as seguintes colunas:

  • CNPJ analisado: CNPJs que constam no arquivo enviado para conciliação.
  • Período inicial: Data de emissão do primeiro sequencial do arquivo. 
  • Período final: Data de emissão do último sequencial do arquivo. 
  • Seq inicial: O primeiro sequencial do arquivo.
  • Seq final: O último sequencial do arquivo.
  • Série: Série do primeiro e último sequencial do arquivo.
  • Faltante InvoiCy: Identificação de quais sequenciais da faixa informada não estão no InvoiCy.
  • Faltante cliente: Identificação de quais sequenciais da faixa informada não estão no arquivo enviado.
  • Status diferente: Relacionar a quantidade de NFC-e que estão com status diferente no InvoiCy x arquivo enviado.
  • Conciliados fora do período: Relação da quantidade de NFC-e enviada fora do período enviado no momento do agendamento da conciliação, e que apresentou inconsistência como diferença no Status ou estar faltante no InvoiCy.

E através do relatório detalhado será possível verificar quais os sequenciais faltantes ou com diferença de status da respectiva conciliação. Com base nisso o usuário poderá corrigir os documentos, e enviar uma nova conciliação.

É importante destacar que quando houver diferença de status entre o sistema do cliente e o InvoiCy, por exemplo, no sistema do cliente o documento se encontra autorizado mas no InvoiCy o mesmo documento está cancelado, será apontada uma divergência na conciliação.

E quando houver documentos faltantes, tanto no cliente como no InvoiCy também será considerada como uma divergência, apresentando o status faltante nos relatórios.