Referência NFS-e

Operações da API de NFS-e

Cada operação tem uma página com o que ela faz, os campos e um exemplo pronto. Para testar e navegar pelos modelos, use a referência interativa.

Login de integradores

Só para quem emite para várias empresas com um token de parceiro. Quem tem token de API (wee_...) não usa esta parte.

Fazer login (só integradores) POST /autenticacao

Empresas

As empresas que emitem notas pela sua conta — dados, certificado digital e configuração da numeração.

Listar empresas GET /empresas
Consultar uma empresa GET /empresas/{cnpj}
Configurar a emissão de NFS-e PUT /empresas/{cnpj}/configuracao-nfse
Enviar o certificado digital A1 PUT /empresas/{cnpj}/certificado

Municípios

Descubra se atendemos a cidade da empresa e quais códigos de serviço a prefeitura aceita.

Verificar se a cidade é atendida GET /municipios/{codigoIbge}
Listar os códigos de serviço da cidade GET /municipios/{codigoIbge}/servicos
Listar as atividades de um código de serviço GET /municipios/{codigoIbge}/atividades

Tabelas de apoio

Listas oficiais usadas no cadastro do serviço e no cancelamento.

Listar indicadores de operação (IBS/CBS) GET /tabelas/ibscbs/indicadores-operacao
Listar classificações tributárias (IBS/CBS) GET /tabelas/ibscbs/classificacoes
Listar motivos de cancelamento GET /tabelas/nfse/motivos-cancelamento

Serviços

Cadastre uma vez cada serviço que a empresa presta. Depois, para emitir, basta informar o serviço, o valor e o cliente.

Listar os serviços da empresa GET /empresas/{cnpj}/servicos
Cadastrar um serviço POST /empresas/{cnpj}/servicos
Consultar um serviço GET /empresas/{cnpj}/servicos/{id}
Alterar um serviço PUT /empresas/{cnpj}/servicos/{id}
Desativar um serviço DELETE /empresas/{cnpj}/servicos/{id}
Simular uma nota (sem emitir) POST /empresas/{cnpj}/servicos/{id}/previa

Emitir e consultar NFS-e

Emita notas e acompanhe a situação de cada uma.

Listar NFS-e GET /nfse
Emitir NFS-e POST /nfse
Consultar NFS-e GET /nfse/{id}
Consultar NFS-e pelo seu código (idIntegracao) GET /nfse/integracao/{idIntegracao}

PDF, XML e e-mail

Os arquivos da nota autorizada e o envio por e-mail.

Baixar o XML da NFS-e GET /nfse/{id}/xml
Baixar o PDF da NFS-e (DANFSe) GET /nfse/{id}/pdf
Enviar a NFS-e por e-mail POST /nfse/{id}/email

Cancelar e reenviar NFS-e

Cancele uma nota autorizada ou tente emitir de novo uma que deu erro.

Cancelar NFS-e POST /nfse/{id}/cancelamento
Tentar emitir de novo POST /nfse/{id}/reprocessamento

Relatórios

Exportação das notas do mês para o contador.

Exportar as notas do mês (para o contador) GET /empresas/{cnpj}/exportacoes/nfse

← Voltar ao início