Referência da API

Todas as rotas de NFCom e NFS-e documentadas neste portal. Clique para ver parâmetros, exemplos e respostas.

NFCom

GET/nfcom/relatorioRelatório de emissão para nota fiscal fatura de serviços de comunicação GET/nfcom/{cnpj}/relatorioRelatório de emissão para nota fiscal fatura de serviços de comunicação por CNPJ POST/nfcomEmitir nota fiscal fatura de serviço de comunicação eletrônica GET/nfcom/{idNotaOrChaveOrProtocol}/resumoConsultar resumo da nota GET/nfcom/{cpfCnpj}/{idIntegracao}/resumoConsultar resumo da nota por id integração POST/nfcom/{idOrChave}/cancelamentoSolicitar cancelamento da nota GET/nfcom/{idOrChave}/cancelamento/statusConsultar a solicitação de cancelamento de uma NFCom POST/nfcom/{idOrChave}/vinculacaoPagamentoSolicitar vinculação da transação de pagamento GET/nfcom/{idOrChaveOrProtocolo}/eventoConsultar a solicitação do evento GET/nfcom/{idOrChaveOrProtocolo}/eventosnfcom/xmlBaixar XML dos eventos POST/nfcom/{idOrChaveOrProtocol}/cancelamentoEventosSolicitar cancelamento de eventos da NFCom POST/nfcom/{idNota}/emailEnviar e-mail GET/nfcom/consulta/periodoConsultar notas por período GET/nfcom/{idNota}/pdfBaixar PDF da nota GET/nfcom/{idNota}/xmlBaixar XML da nota GET/nfcom/{idOrChave}/cancelamento/xmlBaixar XML de cancelamento da nota

NFS-e

POST/nfseEmitir nota de serviço GET/nfse/{idNotaOrProtocol}Consultar nota POST/nfse/servicoCadastrar serviço GET/nfse/servico/{idServico}Consultar serviço PATCH/nfse/servico/{idServico}Alterar serviço DELETE/nfse/servico/{idServico}Deletar serviço POST/nfse/tomadorCadastrar tomador GET/nfse/tomador/{cpfCnpj}Consultar tomador PATCH/nfse/tomador/{cpfCnpj}Atualizar tomador PUT/nfse/tomador/{cpfCnpj}Alterar tomador DELETE/nfse/tomador/{cpfCnpj}Deletar tomador GET/nfse/cidadesConsultar todos os municípios atendidos e metadados GET/nfse/cidades/{codigoIbge}Consultar disponibilidade do município e metadados GET/nfse/pdf/{idNota}Baixar PDF da nota POST/nfse/pdf/{idNota}Regerar PDF da nota por ID POST/nfse/pdf/{idIntegracao}/{cnpj}Regerar PDF da nota por ID integração e cnpj GET/nfse/xml/{idNota}Baixar XML da nota POST/nfse/cancelar/{idNota}Solicitar cancelamento da nota GET/nfse/cancelar/status/{cancellationProtocol}Consultar a solicitação de cancelamento da nota GET/nfse/consultar/{idNotaOrProtocol}Consultar resumo da nota GET/nfse/consultar/{idIntegracao}/{cnpj}Consultar resumo da nota GET/nfse/historico/{idNota}Baixar histórico da nota GET/nfse/historico/{idIntegracao}/{cnpj}Baixar histórico da nota GET/nfse/relatorioRelatório de emissão para nota de serviço POST/nfse/email/{idNota}Enviar e-mail GET/nfse/{cnpj}/relatorioRelatório de emissão para nota de serviço por CNPJ POST/nfse/resolve/{idNota}Resolver uma nota GET/nfse/consultar/periodoConsultar notas por período GET/nfse/rps/pdf/{idNota}Baixar Recibo Provisório de Serviço GET/nfse/rps/pdf/{idIntegracao}/{cnpj}Baixar Recibo Provisório de Serviço GET/nfse/upload/{protocolo}Baixar arquivo Upload POST/nfse/governa/numeracao/Enviar arquivo de AIDF padrão Governa GET/nfse/governa/numeracao/{cnpj}/{protocolo}Consultar envio de arquivo AIDF padrão Governa POST/nfse/interromperInterromper processamento de NFSe GET/nfse/interromper/status/{protocol}Consultar status da interrupção de NFSe POST/nfse/sincronizarSincronizar processamento de NFSe GET/nfse/sincronizar/status/{protocol}Consultar status da sincronização de NFSe