Se a Nota Fiscal Fatura de Serviço de Comunicação Eletrônica é algo novo para você, essa documentação pode ser bem útil.
Sobre a NFCom:
- O que é a Nota Fiscal Fatura de Serviço de Comunicação Eletrônica
- Objetivos da funcionalidade NFCom
- Cadastro de Certificado Digital
- Gerando arquivo de integração NFCom
- Fluxo de envio e consulta
- Fluxo utilizando WebHook
- Lista de Rotas NFCom
O que é Nota Fiscal de Consumidor Eletrônica
A Nota Fiscal Fatura de Serviço de Comunicação Eletrônica é um documento fiscal utilizado por empresas que prestam serviços de comunicação, como telecomunicações, internet, TV a cabo e outros serviços eletrônicos similares. Este documento serve para formalizar e registrar a prestação do serviço e detalhar os valores cobrados, impostos incidentes e outras informações relevantes para o cliente e para o fisco.
Objetivos da Funcionalidade NFCom
- Registro Fiscal: Atender à legislação tributária e garantir que os tributos sejam recolhidos corretamente.
- Transparência: Informar o cliente sobre os valores cobrados e os impostos incidentes.
- Validade Jurídica: Servir como comprovante oficial da prestação do serviço.
Cadastro de Certificado
Cadastre um certificado digital e vincule a sua Empresa, para que possa iniciar a emissão de notas. Quando houver a necessidade do compartilhamento do certificado digital (matriz/filial), não é necessário subir várias vezes o mesmo certificado, um mesmo ID pode ser vinculado a diversas empresas.
Guarde o ID retornados por está rota, você irá precisar dele para o cadastro de empresa.
Observações:
- Utilize o Content-Type igual a multipart/form-data.
- No parâmetro ARQUIVO, envie o arquivo do certificado digital.
- Este recurso está disponível em nossa interface web.
POST
Produção
https://api.plugnotas.com.br/certificado
Sandbox
https://api.sandbox.plugnotas.com.br/certificado
Headers
| Nome | Descrição |
| x-api-key | Header utilizado para autenticação. |
Body: multipart/form-data
| Nome | Tipo | Descrição |
| arquivo | string <binary> |
Arquivo (.PFX,.CER,.P12 ou .P7) do certificado digital.
|
| senha | string | Senha do certificado digital. |
| string | Email para recebimento de notificações sobre o vencimento do certificado digital. |
Gerando arquivo de integração
A integração com o PlugNotas funciona por meio de um arquivo JSON.
Esse arquivo vai receber algumas informações tributárias, que foram coletadas naqueles pontos anteriores que comentamos.
O arquivo em si é bem simples. Suas dúvidas podem ser apenas em relação a alguns campos.
Algumas observações sobre o nosso JSON são as seguintes:
- O arquivo disponibilizado na documentação, é um exemplo que representa UM CASO de envio: uma empresa de Regime Normal (CNPJ da Tecnospeed) com tributação isenta. Qualquer caso diferente disso, pode ser necessário alterar alguns campos diferentes, principalmente em relação à tributação. Campos estes, que estão disponíveis no dicionário de dados.
Essa documentação aqui, é sobre a rota de envio da NFCom e nela você consegue visualizar todos os campos disponíveis para o JSON de envio, bem como a especificação dos campos (string, inteiro, enum...).
POST
Produção
https://api.plugnotas.com.br/nfse/email/{idNota}
Sandbox
https://api.sandbox.plugnotas.com.br/nfse/email/{idNota}
Headers
| Nome | Descrição |
| x-api-key | Header utilizado para autenticação. |
Fluxo de emissão NFCom
Os envios de notas são realizados de forma assíncrona, o que significa que o retorno direto do seu envio, NÃO é informando se a nota está autorizada ou não. Para isso, será necessário o uso de consultas dessas notas ou o uso do webhook para receber notificações. Nessa documentação, ambos os fluxos estão explicados.
Nesse fluxo, vamos assumir que os passos anteriores já foram realizados, como todos os cadastros, configurações da empresa e informações dentro do json.
Fluxo utilizando a consulta
O fluxo se inicia com o envio do arquivo json via API para o PlugNotas. Quando chega ali, nós vamos buscar os dados do cadastro da empresa, setar a numeração da nota, realizar os cálculos de impostos e valores (caso eles não constem no json) e montar o XML para enviar isso tudo para a SEFAZ. Ao mesmo tempo em que todo esse processo é feito, a API já retornou para você o ID dessa nota dentro do nosso banco de dados.
A SEFAZ vai processar essa nota e retornar para nós. Para que você consiga saber o resultado do processamento ou se ela ainda permance em processamento, você deve utilizar a rota de consulta de notas usando como filtro o ID retornado da rota de envio.
O retorno da consulta vai dizer se a nota foi autorizada (CONCLUÍDO), rejeitada (REJEITADO) ou se ainda está pendente de processamento (PROCESSANDO).
Em caso de autorização, o processo por si só está finalizado, mas caso seja do seu interesse ou do seu cliente, você pode solicitar o PDF e/ou o XML dessa nota para o PlugNotas.
Em caso de rejeição, você deve analisar o motivo da rejeição e aplicar a correção, gerando um novo envio depois disso.
Em caso de processamento pendente, resta apenas aguardar e realizar novas consultas periódicamente para saber se o processo foi finalizado.
Fluxo utilizando o WebHook
Para esse fluxo é primordial que se realize as configurações do WebHook para o qual enviaremos as notificações (os Webhooks estão explicados na documentação "Obtendo o retorno").
O fluxo se inicia com o envio do arquivo json via API para o PlugNotas. Quando chega ali, nós vamos buscar os dados do cadastro da empresa, setar a numeração da nota, realizar os cálculos de impostos e valores (caso eles não constem no json) e montar o XML para enviar isso tudo para a SEFAZ. Ao mesmo tempo em que todo esse processo é feito, a API já retornou para você o ID dessa nota dentro do nosso banco de dados.
A SEFAZ vai processar essa nota e retornar para nós. Para que você consiga saber o resultado do processamento, você receberá uma notificação via WebHook configurado anteriormente.
O retorno desse WebHook vai dizer se a nota foi autorizada (CONCLUÍDO) ou rejeitada (REJEITADO).
Em caso de autorização, o processo por si só está finalizado, mas caso seja do seu interesse ou do seu cliente, você pode solicitar o PDF e/ou o XML dessa nota para o PlugNotas.
Em caso de rejeição, você deve analisar o motivo da rejeição e aplicar a correção, gerando um novo envio depois disso.
Notas pendentes de processamento não serão notificadas, apenas notas em estado final.
Lista de Rotas NFCom
| Nome da rota | Método | Rota | Descrição | Retorno |
|---|---|---|---|---|
| Emitir nota | POST | https://api.plugnotas.com.br/nfcom | Realiza o envio assíncrono da nota a partir do JSON no BODY da requisição. | ID da nota em caso de JSON correto, ou um erro de validação de JSON como campos obrigatórios vazios. |
| Solicitando cancelamento da nota | POST | https://api.plugnotas.com.br/nfcom/{idOrChave}/cancelamento | Realiza a requisição do cancelamento assíncrono da nota a através do ID gerado para a nota. | XML de confirmação de cancelamento, em caso de sucesso, ou XML da resposta do servidor. |
| Consultar resumo da notas | GET | https://api.plugnotas.com.br/nfcom/{idNotaOrChaveOrProtocol}/resumo | Traz apenas as informações principais sobre o processamento dessa nota |
Retorna um resumo da nota enviada e o status da nota. A consulta pode apresentar os seguintes status:
|
| Consultar solicitação de cancelamento | GET | https://api.plugnotas.com.br/nfcom/{idOrChave}/cancelamento/status | Consulta o status de sua solicitação de cancelamento pelo ID gerado por nossa API no envio da nota. | Retorna o status da nota, que deve ser "CONCLUIDO" para casos de sucesso, e "REJEITADO" em caso de insucesso. |
| Consultar resumo da nota por ID | GET | https://api.plugnotas.com.br/nfcom/{cpfCnpj}/{idIntegracao}/resumo | Consulta resumida da nota, por CNPJ e idIntegracao. |
Retorna um resumo da nota enviada e o status da nota. A consulta pode apresentar os seguintes status:
|
| Baixar PDF nota | GET | https://api.plugnotas.com.br/nfcom/{idNota}/pdf | Download da impressão em PDF da NFC-e, por ID ou Chave. | Retorna o PDF em bytes. |
| Baixar XML nota | GET | https://api.plugnotas.com.br/nfcom/{idNota}/xml | Download do XML Destinatário da NFC-e, por ID ou Chave. | Retorna o XML destinatário. |
| Enviar e-mail | POST | https://api.plugnotas.com.br/nfcom/{idNota}/email | Envio, ou reenvio de e-mail utilizando o ID da nota. | |
| Consultar notas por período | GET | https://api.plugnotas.com.br/nfcom/consulta/periodo |
Tipos de consulta:
|
Retorna todas as notas enviadas em determinado período, de um cpfCnpj específico, independente de sua situação. |
Comentários
0 comentário
Por favor, entre para comentar.