> 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/ct-e-2/fluxos-operacionais/fluxo-recebimento-ct-e.md).

# 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](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-por-xml.md)
* **Realizar consulta de NFS-e por NSUi**: [/v1/nfse-entrada/{cnpj}/{nsui}](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido.md)
* **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}](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-2.md)
* **Realizar Consulta do PDF Importado por ID:** [/v1/nfse-entrada/obter-pdf-chave/{ambiente}/{id}](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-3.md)
* **Realizar Envio de Anexo:** [/v1/nfse-entrada/anexar](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-por-xml-1.md)
* **Realizar Consulta de Anexo:**[ /v1/nfse-entrada/obter-anexo](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-4.md)
* **Realizar consulta de documentos por NSUI com Campos Customizados:** [/v1/nfse-entrada/eventos-nsui/nsui-custom-fields-lote](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-1.md)

## 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](/invoisys/endpoints/autorizacao/autenticacao-1.md), 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.&#x20;

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FxaASoppHYkKmGRgKZzWR%2FNFSe-prefeitura.png?alt=media&amp;token=8c70f2b5-d195-4e32-b202-39339775e89b" alt="" width="563"><figcaption><p>Consulta de NFS-e na Prefeitura</p></figcaption></figure>

### 2) Envio de XML de NFS-e&#x20;

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.&#x20;

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FHqi8Pge4buWSvNJlYMsq%2FNFSe-xml.png?alt=media&amp;token=25430f08-b477-4ec8-9c6b-2f2f1ec9cc19" alt="" width="563"><figcaption><p>Envio de NFSe via XML</p></figcaption></figure>

### 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;](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-2.md)\
[b) Consulta do PDF de NFS-e;](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido-3.md)\
[c) Consulta por NSUi.](/invoisys/endpoints/recebimento-notas/ct-e-1/api-entrada-de-nf-e-xml-resumido-obtido.md)

#### 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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FiZcP2GAzUmO6KcFBIEMi%2FNFSe-consultaxml.png?alt=media&amp;token=4f50ff25-5ff7-436f-a51d-3220c43520f0" alt="" width="563"><figcaption></figcaption></figure>

#### 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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FlV49c9N0UKcrMHw3UEyP%2FNFSe-PDFxml.png?alt=media&amp;token=fca7b14d-eecc-469a-a970-48087c8334a6" alt="" width="563"><figcaption></figcaption></figure>

**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.&#x20;

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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FdpFptSQqL57h2Wn78ywU%2FNFSe-NSUI.png?alt=media&amp;token=1102ad0f-2a1b-443f-94b1-18977a7ac5ec" alt="" width="563"><figcaption><p>Consulta de NFS-e através do NSUI</p></figcaption></figure>

### 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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FbAGFaGziSEFl63J9ffuq%2FIndicar%20Cancelamento.png?alt=media&amp;token=d0ed9406-f90c-4034-91a7-fbc5db5dedb9" alt="" width="563"><figcaption><p>Indicar Cancelamento</p></figcaption></figure>

### 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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FarWKrtyhkaezvPxEugKb%2FEnviar-anexo.png?alt=media&amp;token=5e2700f8-f68f-4bdc-89a2-dd3b51493684" alt="" width="563"><figcaption><p>Enviar e vincular Anexo</p></figcaption></figure>

### 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.

<figure><img src="https://3525778293-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lmo0dH8REcSzSboskDA%2Fuploads%2FKuVbQFGHyIUY8CPxds68%2FObter-anexo.png?alt=media&amp;token=99f0ccf9-295c-461e-97c5-77b7691cdebb" alt="" width="563"><figcaption><p>Obter anexo via Id do Arquivo</p></figcaption></figure>
