A NFe (Nota Fiscal Eletrônica) é um documento fiscal digital que tem a finalidade de documentar operações de circulação de mercadorias. A NFe contém detalhes importantes sobre a operação, como os dados do emissor (empresa que vende ou presta o serviço), os dados do destinatário (empresa ou pessoa que adquire os produtos ou serviços), descrição dos itens vendidos, valores, impostos incidentes, forma de pagamento, entre outras informações fiscais relevantes. Essa operação é crucial para qualquer negócio, pois garante a documentação legal de todas as transações de venda.

Para realizar o envio da emissão da nota fiscal eletrônica é necessário adicionar o XML da NF-e que deseja autorizar no diretório de saída, com a seguinte nomenclatura:

xxx_zzzzzzzzzzzzzzzzzzzzzzzzz_yyyy

- xxx: Identificação do tipo do arquivo - 3 dígitos.

Valores válidos:
 **  170: Arquivo de mensageria da NF-e para a SEFAZ.

- zzz: Chave de Acesso ou Data/Hora da operação (com milissegundos)
- yyyy: Número aleatório ou o código da impressora cadastrado no Totvs Processos Fiscais (Caso utilize o SIL)- 7 dígitos

Ex. DataHora: 170_2020122155530305_905.xml
Ex. Chave de Acesso.: 170_35210282373077000265652480000032081352517279_0102.xml

Image Added

Exemplo de XML:

Image Added

Retorno:

Após envio do arquivo para o Totvs Processos Fiscais, o retorno do XML da NF-e é disponibilizado no diretório de entrada. A nomenclatura apresenta da mesma forma que o arquivo foi enviado, acrescentando apenas a quarta "casa":

xxx_zzzzzzzzzzzzzzzzzzzzzzzzz_yyyy_wwww

- xxx: Identificação do tipo do arquivo - 3 dígitos.

Valores válidos:
 **  170: Arquivo de mensageria da NF-e para a SEFAZ.

- zzz: Chave de Acesso ou Data/Hora da operação (com milissegundos)
- yyyy: Número aleatório ou o código da impressora cadastrado no Totvs Processos Fiscais (Caso utilize o SIL)- 7 dígitos
-wwww: Número aleatório que o TPF insere - 4 dígitos

Ex. DataHora: 170_2020122155530305_905_1258.xml
Ex. Chave de Acesso.: 170_35210282373077000265652480000032081352517279_0102_1681.xml

Image Added

Exemplo Retorno de Documento Rejeitado:

Image Added

Exemplo Retorno de Documento Autorizado:

Image Added

Fluxos de Emissão de NF-e por API

Neste capítulo, exploraremos os fluxos de emissão de NF-e por API, descrevendo detalhadamente cada um dos fluxos que estão disponíveis e como eles funcionam.

Vale ressaltar que o Swagger referente a essas integrações se encontra disponível pelo link:

Autenticação na API

Para acessar e interagir com a API da Plataforma Fiscal, é necessário realizar a autenticação. Isso garante que apenas usuários autorizados tenham permissão para acessar e realizar operações com a API. A autenticação é feita através de um token, especificamente um Bearer Token.

Um Bearer Token é uma maneira de autenticação stateless onde o servidor não mantém nenhuma informação sobre o cliente entre as solicitações. O cliente deve enviar o token em cada solicitação, e esse token é suficiente para identificar e autenticar o cliente.

Para obter o token de autenticação, é preciso fazer uma requisição para o seguinte endpoint:  plataformafiscal.totvs.com.br/api/v1/login 

 A requisição deve conter um payload (carga útil) com as seguintes informações:

Uma vez que a requisição é realizada corretamente, a Plataforma Fiscal retorna o Bearer Token, que deve ser incluído em todas as solicitações subsequentes para a API. Isso garante que o usuário esteja devidamente autenticado e possa interagir com as funcionalidades da API de maneira segura e controlada.

Emissão de NF-e

A emissão de Nota Fiscal Eletrônica (NF-e) é feita através do método POST para o endpoint /v1/nfe/emissao-xml.

Esta API permite o envio de uma NF-e no formato XML, que é o padrão estabelecido pela SEFAZ (Secretaria da Fazenda).

A requisição deve incluir no corpo um objeto JSON com um campo "xml", onde deve ser inserida a string do XML da NF-e a ser emitida.

Request

{
    "xml": "<conteudo do XML da NF-eZ>"
}

Estrutura XML

A Estrutura de XML pode ser encontrado em Estrutura XML

Response

{
    "retorno": "{<informações do retorno>}",
    "sefazStatus": {
        "codigoStatus":"<codigo do status>",
        "descricaoCodigoStatus" : "<descrição do status>"
    }
}

 Códigos de Status HTTP

200

OK

 A requisição foi bem sucedida. O corpo da resposta contém um objeto JSON com informações sobre o retorno e o status na Sefaz.

 201

 Created

 A NF-e foi autorizada pela Sefaz.

 400

 Bad Request

 Indica que um ou mais campos obrigatórios não foram informados na requisição.

 401

 Unauthorized

 O usuário não está autenticado.

 403

 Forbidden

 O usuário autenticado não tem permissão para acessar o recurso solicitado.

 404

 Not Found

 O recurso solicitado não foi encontrado.

 422

 Unprocessable Entity