Fluxo geral da emissão (NFS-e)

Pontos principais:

O processo é realizado de forma assíncrona;
O retorno do município pode demorar de poucos segundos a vários minutos dependendo da estabilidade do município e seus provedores;
Caso o município esteja instável ou fora do ar, serão realizadas tentativas automáticas, com intervalos de tempo progressivos, até conseguirmos um retorno durante um período de no máximo 48 horas;
Quando a nota fiscal entra em um status final, a Nota Gateway notifica seu sistema através de Webhooks.

Visão do fluxo:

Passo 1 - Solicita emissão:

Solicite a emissão da nota fiscal, através de uma requisição de método POST na URL https://api.notagateway.com.br/v1/empresas/empresaId/nfes;

Repita esse passo para cada nota fiscal a ser emitida. O Gateway gerenciará a fila e determinará a forma mais eficaz de emissão das notas naquele município.

🚧
Identificação:
Utilize o atributo "idExterno" (string) para informar uma identificação da nota no seu próprio sistema, para que consiga vincular e encontrar informações com muito mais facilidade.
A Nota Gateway não permite o envio de mais de uma nota fiscal com o mesmo "idExterno", mesmo com a mudança de ambiente (Homologação, Produção).

Passo 2 - Processo interno de enfileiramento:

A Nota Gateway organiza as notas fiscais em uma fila interna de processamento, garantindo que sejam enviadas ao sistema emissor de forma controlada, uma a uma.

Passo 3 - Retorno do Identificador da nota:

A Nota Gateway retorna o identificador único interno da nota fiscal (atributo nfeId), criado especificamente para aquele documento e que não pode ser alterado ou removido.

Recomendamos que você sempre armazene e utilize esse identificador em qualquer operação relacionada à nota fiscal.

Passo 4 - Procedimento interno de envio ao município:

A Nota Gateway executa o procedimento interno responsável por transmitir a nota fiscal ao município, adotando automaticamente a estratégia mais adequada para a cidade em questão.

Passo 5 - Procedimento interno de consulta no município:

A Nota Gateway realiza consultas periódicas junto ao município para acompanhar o processamento da nota fiscal e identificar o status mais atualizado.

Passo 5.1 - Procedimento interno de novas tentativas:

Quando necessário, a Nota Gateway realiza novas tentativas automáticas de comunicação com o município, especialmente em cenários de instabilidade ou quando a nota ainda não foi processada pela prefeitura.

Passo 6 - Procedimento interno de retorno:

A Nota Gateway consolida o resultado do processamento no município e atualiza o status final da nota fiscal dentro da plataforma.

Passo 7 - Notificação via Webhook:

Sempre que o status da nota fiscal é atualizado, a Nota Gateway envia uma notificação via Webhook para o seu sistema, permitindo que você acompanhe o ciclo da nota em tempo quase real.