> For the complete documentation index, see [llms.txt](https://integracao.gitbook.io/invoisys/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integracao.gitbook.io/invoisys/getting-started/documentos-fiscais/recebimento/nf-e-1/fluxos-operacionais/fluxo-recebimento-nf-e.md).
# Fluxo - Recebimento NF-e
O fluxo demonstrado a seguir trata o recebimento de NF-e dentro da integração com a InvoiSys.
## APIs Essenciais 💡
* **Requisitar consulta por Chave de Acesso**: [/api/nfeentrada/entradadanfe](/invoisys/endpoints/recebimento-notas/nf-e/api-consulta-recebimento-nf-e-por-chave-de-acesso.md)
* **Enviar manifesto do documento:** [/api/nfeentrada/manifestar](/invoisys/endpoints/recebimento-notas/nf-e/api-realizar-manifesto-da-nf-e.md)
* **Realizar download do documento**: [/api/nfeentrada/download](/invoisys/endpoints/recebimento-notas/nf-e/api-realizar-download-de-nf-e-na-sefaz.md)
* **Realizar consulta de documento por NSUi**: [/v1/nfe-entrada/eventos-nsui/{cnpj}/{nsui}](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido.md)
## APIs Opcionais 🥈
* **Realizar Envio de XML de NF-e:** [/v1/nfe-entrada/enviar-xml](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-por-xml-1.md)
* **Realizar Consulta XML por Chave de Acesso:** [/v1/nfe-entrada/obter-xml-chave/{ambiente}/{chaveDeAcesso}](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-3.md)
* **Realizar Consulta XML Importado por ID:** [/v1/nfe-entrada/obter-xml-chave/{ambiente}/{id}](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-3.md)
* **Realizar Consulta do PDF por Chave de Acesso:** [/v1/nfe-entrada/obter-pdf-chave/{ambiente}/{chaveDeAcesso}](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-4.md)
* **Realizar Consulta do PDF Importado po ID:** [/v1/nfe-entrada/obter-pdf-chave/{ambiente}/{id}](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-4.md)
* **Realizar Envio de Anexo:** [/v1/nfe-entrada/anexar](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-por-xml-2.md)
* **Realizar Consulta de Anexo:** [/v1/nfe-entrada/obter-anexo](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-5.md)
* **Realizar consulta de documentos por NSUI com Campos Customizados:** [/v1/nfe-entrada/eventos-nsui/nsui-custom-fields-lote](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-1.md)
## Etapas e suas APIs
Para detalharmos melhor a operação, a separamos em tópicos, [porém você consegue ver o fluxo completo aqui](/invoisys/getting-started/documentos-fiscais/recebimento/nf-e-1/fluxos-operacionais.md) 📝.
### 1) Requisições e consultas periódicas
Antes de iniciamos a consulta da nota, é 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.
A princípio, nossa solução irá fazer a consulta periódica por documentos que foram emitidos contra o seu estabelecimento direto na SEFAZ. Da mesma forma, você poderá pedir para que o sistema faça isto com um documento em específico, utilizando a [API de Consulta por Chave de Acesso](/invoisys/endpoints/recebimento-notas/nf-e/api-consulta-recebimento-nf-e-por-chave-de-acesso.md).
Aqui existem algumas informações que podem ser interessantes você guardar, como a própria `chaveDeAcesso` e o `id` do documento criado em nossa base. Estas informações são importante, já que elas são utilizados em outras APIs.
### 2) Realização do Manifesto
Com as informações do documento emitido contra a empresa em nossa base, você poderá realizar o envio de um manifesto. Usado para realizar a entrada do documento no sistema diretamente por seu XML completo.
Um manifesto que pode ser composto por 4 tipos de eventos:
* Ciência da Operação;
* Confirmação da Operação;
* Desconhecimento da Operação;
* Operação não Realizada.
{% tabs %}
{% tab title="Retorno da Operação de Manifesto" %}
```javascript
{
"data": "0001-01-01T00:00:00",
"tipo": {
"key": 19,
"value": "Confirmação da Operação"
},
"statusSEFAZ": "135",
"descricaoSEFAZ": "Evento registrado e vinculado a NF-e",
"xml": null
}
```
{% endtab %}
{% endtabs %}
### 3) Download NF-e na SEFAZ
Como inicialmente temos somente o Resumo da NF-e, após a realização do Manifesto é necessário que seja realizado o download do XML completo da NF-e na SEFAZ, está API fica disponível para efetuar esta requisição do download do XML na SEFAZ.
### 4) 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 NF-e;](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-3.md)\
[b) Consulta do PDF de NF-e;](/invoisys/endpoints/recebimento-notas/nf-e/api-entrada-de-nf-e-xml-resumido-obtido-4.md)\
c[) Consulta por NSUi](#c-consulta-por-nsui).
#### a) Consulta do XML de NF-e por Chave de Acesso e Por ID
Está API é utilizada para efetuar a consulta do XML no formato base64 de uma NF-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 NF-e por Chave de Acesso e Por ID
Está API é utilizada para efetuar a consulta do PDF no formato base64 de uma NF-e de Entrada, pela Chave de Acesso do documento ou por seu ID, retornado no momento da carga do documento.
#### **c) Consulta por NSUi**
Este e o processo de consulta dos documentos utilizando o Número Sequencial Único Invoisys (NSUi), que são vinculados aos Documentos e Eventos capturados através do webservice da SEFAZ ou importados via API, individualmente por CNPJ.
Cada Consulta Retorna até 50 documentos de acordo com o Numero Sequencial, informando também o ultimo numero consultado;
Consulta de NF-e através do NSUI
Exemplo de Retorno da API de Consultar NSUI de NF-e de Entrada:
{% code overflow="wrap" fullWidth="false" %}
```javascript
{
"tipoDoc": 1,
"nsuiMaxDisponivel": 999999,
"documentos": [
{
"nsuiMaxDisponivel": 999999,
"nsui": 999999,
"docId": 1229554,
"createDate": "2024-09-09T23:41:40.46734",
"tipoDoc": 1,
"chaveDoc": "35240954389083000181550030000000291415436575",
"serie": "3",
"numero": "29",
"dataHoraEmissao": "2024-09-09T17:45:18",
"tipoEvento": 1001,
"descricaoEvento": "XML Completo",
"xmlEvento": "PG5mZVByb2MgdmVyc2FvPSI0LjAwIiB4bWxucz0iaHR0cDovL3d3dy5wb3JAgICA8L2lkZT4NCiAgICAgIDxlbWl0Pg0KICAgICAgICA8Q05QSj41NDM4OTA4MzAwMDE4M..."
}
]
}
```
{% endcode %}
### 5) Envio de XML de NF-e
Também é possível realizar a carga dos XMLs de NF-e no layout ProcNFe no formato base64 através da API de Envio de NF-e.
### 6) 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.
Enviar e vincular Anexo
### 7) 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.