NFS-e · padrão nacionalBeta
Emissão de NFS-e pela API, no padrão nacional
Para prestadores de serviço e escritórios que emitem para os clientes: a DFe Digital está levando a emissão, a consulta, o cancelamento e a substituição de NFS-e para a mesma API que já captura as suas notas. O módulo está em beta, e as empresas entram acompanhadas pelo time.
O que a beta já faz e o que está em construção
O que já existe
- Endpoints de emissão, consulta pela chave de acesso, cancelamento, substituição e status do serviço
- Autenticação pela chave de API da organização, válida para todas as empresas
- Assinatura da DPS com o certificado A1 cadastrado na empresa
- Resposta na mesma chamada: chave de acesso e XML autorizado, ou os erros devolvidos pelo padrão nacional
- Captura das NFS-e emitidas e recebidas pelo Ambiente de Dados Nacional, com XML e DANFSe em PDF
Em construção para sair da beta
- Envio completo da DPS: prestador, tomador, local da prestação, ISS e retenções
- Consulta das NFS-e emitidas por período
- DANFSe e registro da nota no painel no momento da emissão
- Emissão pelo painel, sem precisar da API
Como o módulo funciona
Passo 1
Empresa e certificado
A empresa prestadora fica cadastrada na plataforma com o certificado digital A1 (arquivo .pfx ou .p12 e senha).
Passo 2
Emissão pela API
O seu sistema envia a DPS para a API com a chave de API da organização. A resposta traz a chave de acesso e o XML autorizado.
Passo 3
XML e DANFSe
A nota emitida chega à plataforma pela captura do padrão nacional, com o XML e o DANFSe em PDF, junto das NFS-e recebidas.
Passo 4
Cancelamento e substituição
Cancelar ou substituir uma NFS-e também é uma chamada na API, pela chave de acesso da nota.
Os endpoints
Todos pedem a chave de API da organização no cabeçalho x-api-key e o id da empresa prestadora na rota. O modelo completo de cada chamada está na referência da API.
| Chamada | O que faz |
|---|---|
POST/api/v1/nfse/{companyId}/emit | Envia a DPS e devolve a chave de acesso e o XML autorizado |
GET/api/v1/nfse/{companyId}/query/{chave} | Consulta uma NFS-e pela chave de acesso |
POST/api/v1/nfse/{companyId}/cancel | Registra o cancelamento de uma NFS-e |
POST/api/v1/nfse/{companyId}/substitute | Substitui uma NFS-e por uma nova DPS |
GET/api/v1/nfse/{companyId}/status | Verifica se o serviço do padrão nacional está respondendo |
Cobertura: só o padrão nacional
A emissão e a captura de NFS-e da DFe Digital usam o padrão nacional da NFS-e. Municípios que mantêm sistema próprio, fora do padrão nacional, não são atendidos. As NFS-e recebidas e emitidas chegam pelo Ambiente de Dados Nacional, como prestador e tomador; veja o que a plataforma faz com a NFS-e.
Perguntas frequentes
- A DFe Digital emite NFS-e?
- Sim, em beta. A emissão no padrão nacional está na API da plataforma e as empresas entram na beta acompanhadas pelo time. Para participar, fale com a gente pelo WhatsApp.
- Funciona em qualquer município?
- Só no padrão nacional da NFS-e. Municípios que mantêm sistema próprio e não aderiram ao padrão nacional não são atendidos, nem na emissão nem na captura.
- Preciso de certificado digital?
- Sim, o certificado A1 da empresa prestadora (arquivo .pfx ou .p12, com senha), cadastrado na plataforma. Certificado A3 não é suportado.
- Dá para emitir pelo painel?
- Ainda não. Na beta a emissão é só pela API REST. O painel mostra as NFS-e que chegam pela captura do padrão nacional, emitidas e recebidas.
- Como sei se a nota foi autorizada?
- A chamada de emissão responde na hora: com a chave de acesso e o XML autorizado quando a nota é aceita, ou com os erros devolvidos pelo padrão nacional. Webhooks ainda não existem.
- E o DANFSe?
- O DANFSe em PDF é gerado pela plataforma para as NFS-e que entram pela captura do padrão nacional, inclusive as emitidas pela própria empresa.
Quer emitir NFS-e pela DFe Digital?
Conte qual é o seu volume e o seu sistema. A gente acompanha a entrada da sua empresa na beta e avisa quando o módulo sair dela.