Referência da API
Introdução à referência
Cada operação tem uma página com método e endereço, parâmetros, corpo com todos os campos, respostas por status e exemplos em cURL e JavaScript. Os exemplos usam somente dados fictícios.
- Endereço base:
https://app.notemfiscal.com.br/api/v1 - Autenticação:
Authorization: Bearer {chave}em todas as chamadas. Veja Autenticação. - Erros: sempre no formato descrito em Erros.
- Especificação completa para ferramentas (OpenAPI 3.1): openapi.yaml.
Status
GET /status— Confirma que a chave funciona e informa o ambiente, a organização e a integração.
Empresas
GET /empresas— Lista as empresas emitentes da organização, da mais recente para a mais antiga.POST /empresas— Cadastra uma empresa que vai emitir notas pela notem.GET /empresas/{id}— Devolve os dados cadastrais de uma empresa.PATCH /empresas/{id}— Altera os dados de uma empresa, ou a desativa e reativa.DELETE /empresas/{id}— Exclui uma empresa que nunca emitiu nota.
Configuração fiscal
GET /empresas/{id}/configuracao-fiscal— Devolve como a empresa é tributada: Simples Nacional, regimes e tributos aproximados.PUT /empresas/{id}/configuracao-fiscal— Grava como a empresa é tributada e recusa combinações que o governo não aceita.
Certificado
GET /empresas/{id}/certificado— Mostra os dados do certificado digital ativo, como titular e validade.POST /empresas/{id}/certificado— Envia ou troca o certificado digital A1 que a empresa usa para assinar as notas.
Serviços
GET /empresas/{id}/servicos— Lista os serviços cadastrados na empresa, ativos e inativos.POST /empresas/{id}/servicos— Cadastra um serviço que a empresa presta, com os códigos que vão na nota.GET /empresas/{id}/servicos/{servico_id}— Devolve um serviço cadastrado na empresa.PATCH /empresas/{id}/servicos/{servico_id}— Altera um serviço ou o desativa.
Tomadores
GET /empresas/{id}/tomadores— Lista os clientes (tomadores) cadastrados em uma empresa.POST /empresas/{id}/tomadores— Guarda os dados de um cliente para usar nas próximas notas.GET /empresas/{id}/tomadores/{tomador_id}— Devolve os dados de um tomador cadastrado na empresa.PATCH /empresas/{id}/tomadores/{tomador_id}— Altera os dados de um tomador cadastrado.
Situação da empresa
GET /empresas/{id}/situacao— Diz se a empresa está pronta para emitir no ambiente da chave e o que falta.POST /empresas/{id}/situacao/verificar-municipio— Consulta no governo se o município da empresa aceita a NFS-e nacional e atualiza a situação.
Sincronização
GET /empresas/{id}/sincronizacao— Mostra quando a empresa foi sincronizada com o governo pela última vez e o resultado.
Notas
GET /notas— Lista as notas da organização no ambiente da chave, da mais recente para a mais antiga.POST /notas— Envia a NFS-e ao governo e devolve a nota autorizada ou o motivo da recusa.GET /notas/{id}— Devolve a nota completa, com situação, valores, tomador e links do XML e do PDF.GET /notas/{id}/xml— Baixa o XML oficial da nota, exatamente como o governo devolveu.POST /notas/{id}/cancelar— Pede ao governo o cancelamento de uma nota autorizada e devolve a nota cancelada ou o motivo da recusa.POST /notas/{id}/solicitar-analise-cancelamento— Pede à prefeitura que analise um cancelamento que o município não permite fazer diretamente.POST /notas/{id}/substituir— Emite uma nova nota que corrige e substitui uma nota autorizada.GET /notas/{id}/eventos/{codigo}/xml— Baixa o XML oficial de um cancelamento ou de um pedido de análise registrado no governo.GET /notas/{id}/pdf— Gera o PDF da nota (DANFSe) a partir do XML oficial.
Notas recebidas
GET /empresas/{id}/notas-recebidas— Lista as notas em que a empresa aparece como cliente (tomadora) ou intermediária.GET /empresas/{id}/notas-recebidas/{nota_id}— Devolve uma nota recebida pela empresa.GET /empresas/{id}/notas-recebidas/{nota_id}/xml— Baixa o XML oficial da nota recebida, sem alterações.GET /empresas/{id}/notas-recebidas/{nota_id}/pdf— Gera o PDF (DANFSe) de uma nota recebida a partir do XML oficial.
Catálogos
GET /catalogos/municipios— Busca municípios pelo nome ou pelo código IBGE.GET /catalogos/servicos— Busca códigos da lista nacional de serviços pela descrição ou pelo código.GET /catalogos/nbs— Busca códigos NBS pela descrição ou pelo código.GET /catalogos/classificacoes-tributarias— Lista as classificações tributárias do IBS/CBS aceitas na NFS-e.GET /catalogos/indicadores-operacao— Lista os indicadores de operação do IBS/CBS, que dizem o tipo de operação e onde o imposto é devido.GET /catalogos/sugestao-classificacao— Sugere NBS, classificação tributária e indicador de operação para um código de serviço.

