Histórico da Página
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.
| Índice |
|---|
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:
https://plataformafiscal.totvs.com.br/api/swagger-ui.html#/NFe
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:
| Request Method | POST |
|---|---|
| Endpoint | plataformafiscal.totvs.com.br/api/v1/login |
| Request Body | { "username" : "nome-do-usuario", "password" : "senha-usuario" } |
Onde email-usuario é o e-mail do usuário registrado na Plataforma Fiscal esenha-usuario é a respectiva senha.
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
| Request Method | POST |
|---|---|
| Endpoint | plataformafiscal.totvs.com.br/api/v1/nfe/emissao-xml |
| Request Body | { |
Estrutura XML
A Estrutura de XML pode ser encontrado em Estrutura XML
Response
| Endpoint | plataformafiscal.totvs.com.br/api/v1/nfe/emissao-xml |
| Request Body | { |
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 | A NF-e já se encontra em processamento, portanto, não pode ser reprocessada. |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas