Fluxo - Recebimento NFS-e
O fluxo demonstrado a seguir trata do recebimento de NFS-e dentro da integração com a InvoiSys.
APIs Essenciais 💡
Realizar o Envio de NFS-e: /v1/nfse-entrada/enviar-xml
Realizar consulta de NFS-e por NSUi: /v1/nfse-entrada/{cnpj}/{nsui}
Indicar Cancelamento: /v1/nfse-entrada/indicar-cancelamento/{ambiente}/{id}
APIs Opcionais 🥈
Realizar Consulta XML Importado por ID: /v1/nfse-entrada/obter-xml-chave/{ambiente}/{id}
Realizar Consulta do PDF Importado por ID: /v1/nfse-entrada/obter-pdf-chave/{ambiente}/{id}
Realizar Envio de Anexo: /v1/nfse-entrada/anexar
Realizar Consulta de Anexo: /v1/nfse-entrada/obter-anexo
Etapas e suas APIs
Antes de iniciamos a utilização das APIs de envio e consulta de notas, é necessário estar com um token de acesso válido, pois este será utilizado no cabeçalho da chamada das APIs. Tendo ele em mãos, podemos partir para as devidas operações do fluxo.
1) Requisições e consultas periódicas
A princípio, nossa solução irá fazer a consulta periódica por documentos e eventos que foram emitidos contra o seu estabelecimento direto nas Prefeituras e os disponibilizará no sistema.
2) Envio de XML de NFS-e
Também é possível realizar a carga dos XMLs de NFS-e no layout Abrasf no formato base64 através da API de Envio de NFS-e.
3) Consulta de NF-e por Chave de Acesso, ID e NSUi
Com o documento disponibilizado para você em nossa solução, possuímos duas funcionalidades que estão disponíveis para seu auxílio.
a) Consulta do XML de NFS-e; b) Consulta do PDF de NFS-e; c) Consulta por NSUi.
a) Consulta do XML de NFS-e Por ID
Está API é utilizada para efetuar a consulta do XML no formato base64 de uma NFS-e de Entrada, pela Chave de Acesso do documento ou por seu ID, retornado no momento da carga do documento.
b) Consulta do PDF de NFS-e Por ID
Está API é utilizada para efetuar a consulta do PDF no formato base64 de uma NFS-e de Entrada, pela Chave de Acesso do documento ou por seu ID, retornado no momento da carga do documento.
a) Consulta de NFS-e via NSUI
Através da nossa API de consulta por NSUI (Numero Sequencia Unico da Invoisys) você poderá buscar suas NFS-es tomadas e carregadas via API informando ultimo NSUI consultado.
Cada Consulta Retorna até 50 documentos de acordo com o Numero Sequencial, informando também o ultimo numero consultado e o numero sequencial maximo disponível para consulta.
4) Indicar Cancelamento de NFS-e
Quando realizamos as consultas periódicas ao ambiente das Prefeituras conseguimos obter a informação a cerca dos Status dos documentos, porém quando a carga do XML da NFS-e é realizada via portal, não temos esta rastreabilidade do status, portanto disponibilizamos este endpoint para a informação acerca do cancelamento das NFS-es.
5) Enviar Anexo
Através desse endpoint é possível enviar um arquivo (imagem, pdf, texto, etc) e vincula-lo a um documento através de seu ID informado no momento de sua carga ou de sua consulta via NSUI.
6) Consultar Anexo
Através desse endpoint é possível obter o arquivo (imagem, pdf, texto, etc) enviado através do enpoint de Envio de Anexo em base64, utilizando o ID do Arquivo devolvido no momento da carga do anexo.
Last updated
