API reference

Every NFCom and NFS-e route documented in this portal. Open an item to see parameters, examples, and responses.

NFCom

GET/nfcom/relatorioNFCom issuance report GET/nfcom/{cnpj}/relatorioNFCom issuance report by CNPJ POST/nfcomIssue an electronic communication service invoice GET/nfcom/{idNotaOrChaveOrProtocol}/resumoRetrieve an invoice summary GET/nfcom/{cpfCnpj}/{idIntegracao}/resumoRetrieve an invoice summary by integration ID POST/nfcom/{idOrChave}/cancelamentoRequest invoice cancellation GET/nfcom/{idOrChave}/cancelamento/statusCheck an NFCom cancellation request POST/nfcom/{idOrChave}/vinculacaoPagamentoLink a payment transaction GET/nfcom/{idOrChaveOrProtocolo}/eventoCheck an event request GET/nfcom/{idOrChaveOrProtocolo}/eventosnfcom/xmlDownload event XML POST/nfcom/{idOrChaveOrProtocol}/cancelamentoEventosRequest cancellation of NFCom events POST/nfcom/{idNota}/emailSend email GET/nfcom/consulta/periodoList invoices by period GET/nfcom/{idNota}/pdfDownload the invoice PDF GET/nfcom/{idNota}/xmlDownload the invoice XML GET/nfcom/{idOrChave}/cancelamento/xmlDownload the cancellation XML

NFS-e

POST/nfseIssue a service invoice GET/nfse/{idNotaOrProtocol}Retrieve an invoice POST/nfse/servicoRegister a service GET/nfse/servico/{idServico}Retrieve a service PATCH/nfse/servico/{idServico}Update a service DELETE/nfse/servico/{idServico}Delete a service POST/nfse/tomadorRegister a customer GET/nfse/tomador/{cpfCnpj}Retrieve a customer PATCH/nfse/tomador/{cpfCnpj}Partially update a customer PUT/nfse/tomador/{cpfCnpj}Replace a customer DELETE/nfse/tomador/{cpfCnpj}Delete a customer GET/nfse/cidadesList supported municipalities and metadata GET/nfse/cidades/{codigoIbge}Check municipality availability and metadata GET/nfse/pdf/{idNota}Download the invoice PDF POST/nfse/pdf/{idNota}Regenerate the invoice PDF by ID POST/nfse/pdf/{idIntegracao}/{cnpj}Regenerate the invoice PDF by integration ID and CNPJ GET/nfse/xml/{idNota}Download the invoice XML POST/nfse/cancelar/{idNota}Request invoice cancellation GET/nfse/cancelar/status/{cancellationProtocol}Check a cancellation request GET/nfse/consultar/{idNotaOrProtocol}Retrieve an invoice summary GET/nfse/consultar/{idIntegracao}/{cnpj}Retrieve an invoice summary by integration ID GET/nfse/historico/{idNota}Download the invoice history GET/nfse/historico/{idIntegracao}/{cnpj}Download the invoice history GET/nfse/relatorioService invoice issuance report POST/nfse/email/{idNota}Send email GET/nfse/{cnpj}/relatorioService invoice issuance report by CNPJ POST/nfse/resolve/{idNota}Resolve an invoice GET/nfse/consultar/periodoList invoices by period GET/nfse/rps/pdf/{idNota}Download the provisional service receipt GET/nfse/rps/pdf/{idIntegracao}/{cnpj}Download the provisional service receipt GET/nfse/upload/{protocolo}Download the upload file POST/nfse/governa/numeracao/Submit a Governa AIDF file GET/nfse/governa/numeracao/{cnpj}/{protocolo}Check a Governa AIDF upload POST/nfse/interromperInterrupt NFS-e processing GET/nfse/interromper/status/{protocol}Check an NFS-e interruption request POST/nfse/sincronizarResume NFS-e processing GET/nfse/sincronizar/status/{protocol}Check an NFS-e sync request