Bem-vindo à API PlugNotas — a forma mais simples e moderna de emitir documentos fiscais eletrônicos no Brasil.
\nAtravés desta API, você pode integrar o seu sistema à TecnoSpeed PlugNotas, realizando o envio, consulta e cancelamento de notas fiscais de forma unificada, independentemente do tipo de documento ou da prefeitura.
\nA PlugNotas centraliza a comunicação com múltiplos órgãos emissores (prefeituras, SEFAZ e afins), oferecendo uma interface única para:
\nEmissão de NFS-e, NF-e, NFC-e, MDF-e, CFe e NFCom.
\nConsulta de status e recuperação de XMLs/PDFs.
\nGerenciamento de certificados digitais e empresas.
\nVocê pode testar todas as funcionalidades diretamente por aqui, utilizando o ambiente de Sandbox (teste gratuito).
\nDefina o valor da variável https://api.sandbox.plugnotas.com.br conforme o ambiente desejado.
A autenticação é feita via API Key, enviada no header de todas as requisições:
\nX-API-KEY: {{apiKey}}\n\n\n\n💡 Dica: no Postman, configure a variável
\n{{apiKey}}no ambiente Sandbox ou Produção.
Não compartilhe chaves reais em ambientes públicos.
A API é organizada por módulos (pastas nesta Collection), cada um correspondente a um tipo de documento ou recurso:
\nGere seu token de acesso no portal:
👉 https://app2.plugnotas.com.br
baseUrl = https://api.sandbox.plugnotas.com.brapiKey = SEU_TOKEN_AQUI
\nTeste as rotas nesta ordem recomendada:
\nCadastrar certificado digital
\nCadastrar empresa
\nEmitir documento (NFS-e, NF-e, NFC-e...)
\nConsultar status da nota
\nAs requisições são enviadas em JSON (ou multipart/form-data no caso de certificados).
As respostas seguem o formato padrão:
{\n \"id\": \"abcd1234\",\n \"status\": \"processando\",\n \"mensagem\": \"Nota enviada com sucesso\",\n \"protocolo\": \"123456789\"\n}\n\n\n\nCampos adicionais podem variar conforme o tipo de documento e o padrão da prefeitura/SEFAZ.
\n
Sempre salve o id retornado nas emissões — ele será usado para consultas posteriores.
Utilize ambiente Sandbox para testes iniciais e homologação.
\nPara erros específicos, consulte o campo mensagem retornado no JSON.
Configure o Postman para exibir o console (Ctrl + Alt + C) ao testar rotas.
\nPortal PlugNotas: https://plugnotas.com.br
\nPainel do Cliente: https://app2.plugnotas.com.br
\nDocumentação técnica: https://docs.plugnotas.com.br
\nCentral de ajuda: https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313
\nCaso tenha dúvidas, entre em contato:
\nTecnoSpeed S/A – PlugNotas
📧 E-mail: contato@tecnospeed.com.br
🌐 Site: https://plugnotas.com.br
Arquivo (.PFX,.CER,.P12 ou .P7) do certificado digital.
\n","key":"arquivo","type":"file","value":null},{"description":"Senha do certificado digital.
\n","key":"senha","value":"string","type":"text"},{"description":"Email para recebimento de notificações sobre o vencimento do certificado digital.
\n","key":"email","value":"string","type":"text"}]},"url":"https://api.sandbox.plugnotas.com.br/certificado/:idCertificado","description":"Utilize para atualizar um certificado digital que esteja vinculado a múltiplas empresas. Desta forma, um certificado digital compartilhado (matriz/filial) que esteja vencido, pode ser substituído sem a necessidade da atualização de cada empresa individualmente.
\nO ID retornado por está rota, se refere a um novo registro de certificado criado.
\nObservações:
\nID retornado por nossa API, ao cadastrar um certificado digital.
\n","type":"text/plain"},"type":"any","value":"string","key":"idCertificado"}]}},"response":[{"id":"0deab031-fde3-4300-8cdf-7f426db04949","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Utilize para deletar um certificado específico já cadastrado
\n","urlObject":{"path":["certificado",":idCertificado"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"6baa9534-e82a-44ba-8949-5cb29f9fa4ec","description":{"content":"ID do certificado cadastrado
\n","type":"text/plain"},"type":"any","value":"string","key":"idCertificado"}]}},"response":[{"id":"10bd09da-e1df-4f98-b7d2-5e347f47e625","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Utilize para buscar os dados de um certificado específico já cadastrado
\n","urlObject":{"path":["certificado",":idCertificadoOrCpfCnpj"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"35ea2249-ff2a-437b-bfc7-37e45046231a","description":{"content":"ID do certificado cadastrado ou o cpf/cnpj da empresa
\n","type":"text/plain"},"type":"any","value":"string","key":"idCertificadoOrCpfCnpj"}]}},"response":[{"id":"1d7d7ab1-7655-4067-89bb-b9d46ab89fc1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Lista todos os certificados vinculados a sua organização.
\n","urlObject":{"path":["certificado"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"0bad2ed3-cfb3-4531-af01-b52f78790599","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Arquivo (.PFX,.CER,.P12 ou .P7) do certificado digital.
\n","key":"arquivo","type":"file","value":null},{"description":"Senha do certificado digital.
\n","key":"senha","value":"string","type":"text"},{"description":"Email para recebimento de notificações sobre o vencimento do certificado digital.
\n","key":"email","value":"string","type":"text"}]},"url":"https://api.sandbox.plugnotas.com.br/certificado","description":"Cadastre um certificado digital e vincule a sua Empresa, para que possa iniciar a emissão de notas. Quando houver a necessidade do compartilhamento do certificado digital (matriz/filial), não é necessário enviar várias vezes o mesmo certificado, um mesmo ID pode ser vinculado a diversas empresas.
\nGuarde o ID retornado por esta rota, você irá precisar dele para o cadastro de empresa.
\nObservações:
\nRealiza o download do logotipo configurado para a empresa.
\n","urlObject":{"path":["empresa",":cnpj","logotipo"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"2a8e5cbc-dc41-4c60-97fc-bada03baa552","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"9c0d8af1-7c78-4ac6-89ec-cabf1c1623ec","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Arquivo (.PNG, .JPG ou .JPEG) da imagem com tamanho máximo de 200kb
\n","key":"arquivo","type":"file","value":null}]},"url":"https://api.sandbox.plugnotas.com.br/empresa/:cnpj/logotipo","description":"Realiza upload e vincula logotipo a Empresa. Esse logotipo será utilizado para geração do PDF das notas.
\nCenários de uso:
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"588e3dd3-afc8-4090-a6a3-28b8b5fbbddd","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Remove a logotipo da empresa
\n","urlObject":{"path":["empresa",":cnpj","logotipo"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"fc1d28a2-8904-480f-8dd0-c9cef923bd47","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"b633141f-d576-4c19-990b-0a287db4c6ef","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza o envio de um EXEMPLO de Webhook, para os dados configurado na rota /webhook. O retorno deste método é exatamente o conteúdo (body) e status code retornados pelo endpoint configurado.
\n","urlObject":{"path":["empresa",":cnpj","webhook","verify"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"586b1265-5766-4020-9443-86ce7872b6a8","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"4cc3deed-c15a-45bf-b99c-78524a9c35ed","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta o webhook configurado para a Empresa.
\n","urlObject":{"path":["empresa",":cnpj","webhook"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"e4e31f9d-65df-4668-9723-aa5ad4cf58e0","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"12b1e360-d00e-402b-b76e-aee1e27363b8","name":"SUCESSO","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Altera as configurações do webhook para a Empresa.
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"6c2d822f-6298-47e5-9ad6-2b73f92fc3b5","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Configura um webhook para a Empresa, neste contexto, é possível utilizar um endpoint diferente para cada emitente. Se você deseja utilizar um único endpoint para todas as suas empresas, recomendamos que utilize a rota /webhook.
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"be1e0b1a-c885-4af7-8e59-1992d5c6c389","name":"SUCESSO","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Remove o webhook vinculado a Empresa.
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"77d81eee-19db-4663-85fa-776cc6c432dc","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Remove a série vinculada a Empresa.
\n","urlObject":{"path":["empresa",":cnpj",":documento",":serie","serie"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"2a13b743-4c3b-4a42-8c0a-864a3b870073","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"},{"id":"882ea69f-db78-4470-af48-57e3123560f9","description":{"content":"Tipo do documento. Valores permitidos: NFS-e, NF-e, NFC-e, MDF-e, CF-e, NFCom
\n","type":"text/plain"},"type":"any","value":"mdfe","key":"documento"},{"id":"e668fa70-1909-4c0f-90e5-28bc36474acf","description":{"content":"Número da série que será removida
\n","type":"text/plain"},"type":"any","value":"string","key":"serie"}]}},"response":[{"id":"bec7cb64-e837-40cc-a80e-0dc2ba81e064","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta o cadastro de um CNPJ (emitente/prestador), que esteja vinculado a sua organização.
\n","urlObject":{"path":["empresa",":cnpj"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"c70e5961-1ac9-4964-9716-34822beaff5e","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"4e755b87-b224-467f-ba4d-6f82587e4e65","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Altera o cadastro de um CNPJ (emitente/prestador), que esteja vinculado a sua organização. Neste método, você pode alterar um único campo específico, ou todo o cadastro.
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"f83a85c4-8341-417d-a798-9d66db388945","name":"SUCESSO","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Lista todas as Empresas vinculadas a sua organização, com um limite de 150 registros por paginação.
\n","urlObject":{"path":["empresa"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"ID da última empresa retornada na paginação.
\n","type":"text/plain"},"key":"hashProximaPagina","value":"604773edbeeb7d1d0c2dd7fa"}],"variable":[]}},"response":[{"id":"01317762-f231-4e36-9547-4d10668baad3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Cadastra e vincule uma nova Empresa (emitente/prestador) a sua organização.
\nPara evitar erros ao longo do processo, algumas validações são dinâmicas, sendo requeridas de acordo com o documento, e município selecionado, são elas:
\nCenários de uso:
\nObservações:
\nGera um relatório sintético de todas as NFS-e, NF-e, Notas Destinadas (DF-e), NFC-e e MDF-e, emitidas por CNPJs vinculados à organização.
\n","urlObject":{"path":["relatorio",":ano",":mes"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"d6696653-08b2-4fea-9fd9-7dd7c5c5deb5","description":{"content":"Ano a ser consultado.
\n","type":"text/plain"},"type":"any","value":"string","key":"ano"},{"id":"33190507-0931-456b-a741-ae6f1448a574","description":{"content":"Mês a ser consultado.
\n","type":"text/plain"},"type":"any","value":"string","key":"mes"}]}},"response":[{"id":"80465b95-bcd3-4b93-ad31-e9bbfd523833","name":"Ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza o envio de um EXEMPLO de Webhook, para os dados configurado na rota /webhook. O retorno deste método é exatamente o conteúdo (body) e status code retornados pelo endpoint configurado.
\n","urlObject":{"path":["webhook","verify"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"90b4d425-9764-4c31-9c72-82b9cd57322b","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta o webhook configurado para a sua organização.
\n","urlObject":{"path":["webhook"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"a5f0b0a2-a053-46a1-9f07-18385ebcadfc","name":"SUCESSO","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Altera as configurações do webhook vinculado a sua organização.
\nObservações:
\nConfigura um webhook geral para toda a sua organização. Se você deseja utilizar um endpoint diferente para cada Empresa, recomendamos que utilize a rota /empresa/{cnpj}/webhook.
\nObservações:
\nRemove o webhook vinculado a sua organização.
\nObservações:
\nConsulta o endereço completo, à partir do CEP.
\nObservações:
\nCEP sem máscara.
\n","type":"text/plain"},"type":"any","value":"string","key":"cep"}]}},"response":[{"id":"c24bc4d5-818e-4adb-8a14-47ca390d4a02","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta os dados cadastrais de um CNPJ na Receita Federal.
\nObservações:
\nCNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"abf0c3e6-076b-4e22-b9fe-18faa9cd1089","name":"SUCESSO","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta dados das notas a partir de seu ID ou protocolo.
\nObservações:
\nID ou protocolo gerado por nossa API, ao enviar uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNotaOrProtocol"}]}},"response":[{"id":"1b89c00d-d7b1-4075-a513-d9a8a47cf2e2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta dados de um serviço já cadastrado.
\n","urlObject":{"path":["nfse","servico",":idServico"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"70ee9649-9423-4afe-8d6b-0aa310189dac","description":{"content":"ID retornado por nossa API, ao cadastrar um serviço.
\n","type":"text/plain"},"type":"any","value":"string","key":"idServico"}]}},"response":[{"id":"63ac4c7b-686f-4e78-b451-4cbf09e65665","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Altera dados de um serviço já cadastrado.
\n","urlObject":{"path":["nfse","servico",":idServico"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"b2d132e4-c1d6-4208-bd59-0c52b1292f8c","description":{"content":"ID retornado por nossa API, ao cadastrar um serviço.
\n","type":"text/plain"},"type":"any","value":"string","key":"idServico"}]}},"response":[{"id":"bcb697d1-038c-42dd-bf33-a1b47113a29a","name":"Dados do serviço vinculado ao ID informado, caso exista.","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Excluir dados de um serviço já cadastrado.
\n","urlObject":{"path":["nfse","servico",":idServico"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"5f3fb777-782e-4240-86c6-9cca04d0ce31","description":{"content":"ID retornado por nossa API, ao cadastrar um serviço.
\n","type":"text/plain"},"type":"any","value":"string","key":"idServico"}]}},"response":[{"id":"22c9cf2a-2af7-4fee-8419-c7b1fe0fc621","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza o cadastro de um serviço para simplificar a emissão. Ao realizar o cadastro, será retornado um ID, utilize esse ID no JSON de envio da nota.\n{\n...\n\"servico\": {\n \"id\": \"abc123\"\n}\n...\n}
\nObservações:
\nConsulta os dados de um tomador já cadastrado.
\n","urlObject":{"path":["nfse","tomador",":cpfCnpj"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"b4f700f5-f1ee-41f6-a6cd-9addb771c56a","description":{"content":"Informe o CPF ou CNPJ utilizado.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"}]}},"response":[{"id":"b1686b03-e841-4887-b2e3-698c5e446629","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Para atualizar dados de um tomador já cadastrado.
\nObservações:
\nInforme o CPF ou CNPJ utilizado.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"}]}},"response":[{"id":"4f1a515d-8b3c-4349-bd96-0b214bc8cb41","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Para alteração completa dos dados de um tomador já cadastrado.
\nObservações:
\nInforme o CPF ou CNPJ utilizado.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"}]}},"response":[{"id":"01c459e3-17ec-4eb1-bfb2-c181a69797b8","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Para excluir dados de um tomador já cadastrado.
\nObservações:
\nInforme o CPF ou CNPJ utilizado.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"}]}},"response":[{"id":"d4bea7a9-102e-4a37-b70e-f08ed2f0c492","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza o cadastro de um tomador para simplificar a emissão. Ao realizar o cadastro, será retornado um ID, utilize esse ID no JSON de envio da nota.\n{\n...\n\"tomador\": {\n \"id\": \"abc123\"\n}\n...\n}
\nObservações:
\nConsulta através do código IBGE, a disponibilidade para emissão, e algumas de suas particularidades.
\nCenários de uso:
\nObservações:
\nCódigo IBGE da cidade que será consultada.
\n","type":"text/plain"},"type":"any","value":"string","key":"codigoIbge"}]}},"response":[{"id":"70c51624-0d53-479f-b221-3f39ba14f71e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Fornece uma relação completa de todos os municípios atentidos pela Tecnospeed, e algumas de suas particularidades.
\nObservações:
\nDownload da impressão em PDF da NFS-e por ID.
\nObservações:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"7067b3ff-4161-40de-9418-a4bd20bc6559","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Regerar impressão em PDF da NFS-e por ID.
\nObservações:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"67671160-9a9a-44d2-ad50-04fbca630e83","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Regerar impressão em PDF da NFS-e por ID integração e cnpj.
\nObservações:
\nCódigo único gerado por sua aplicação.
\n","type":"text/plain"},"type":"any","value":"string","key":"idIntegracao"},{"id":"0eb68eff-8ca8-4ff1-bea6-db1893f1c11c","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"59e0229a-f51b-4c11-9dec-6e171678cdc9","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Download do XML da NFS-e por ID.
\nObservações:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"c554fb81-8992-450d-bddf-bf93f1006d44","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza uma solicitação de cancelamento de NFS-e por ID.
\nObservações:
\nNFSe Nacional
\n1 - Erro na Emissão\n 2 - Serviço não Prestado\n 9 - OutrosObs.: Por default, para a NFSe Nacional será utilizado o código 9 e o motivo será 'Cancelamento a pedido do Prestador'
\n","urlObject":{"path":["nfse","cancelar",":idNota"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"b2db1532-4f8e-4454-a483-9522d4b78b95","description":{"content":"ID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"95d93d3d-5783-44ff-abee-54d21710641f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza uma solicitação de cancelamento de NFS-e por ID.
\nObservações:
\n1 - Erro na Emissão\n 2 - Serviço não Prestado\n 9 - OutrosObs.: Por default, para será utilizado o código 9 e o motivo será 'Cancelamento a pedido do Prestador'
\n","urlObject":{"path":["nfse","cancelar","string "],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"067dfc8c-4b53-4db0-b394-3059342b78ac","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta o status de sua solicitação de cancelamento. Para facilitar a sua integração, é recomendado que observe o campo status, que deve ser \"CONCLUIDO\" para casos de sucesso, e \"REJEITADO\" em caso de insucesso.
\nObservações:
\nProtocolo da solicitação de cancelamento, obtido na resposta da requisição de cancelamento da NFSe.
\n","type":"text/plain"},"type":"any","value":"string","key":"cancellationProtocol"}]}},"response":[{"id":"8df5615b-725d-48b6-a773-ec3e4eb86220","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Download do XML de Evento por ID e Protocolo.
\n","urlObject":{"path":["nfse","eventos",":idNota",":protocolEvent","xml"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"74dc9bfb-84a6-41d0-8d1a-83e25f886b72","description":{"content":"ID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"},{"id":"a3c79c06-1a2d-4a29-8add-7030421f1cdd","description":{"content":"Protocolo de evento gerado por nossa API, ao enviar uma solicitação de manifestação.
\n","type":"text/plain"},"type":"any","value":"string","key":"protocolEvent"}]}},"response":[{"id":"ad65549a-88ac-4dc7-8ae1-e056f6d6209d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/xml"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta um único evento a partir do ID NFSe e Protocolo do evento.
\n","urlObject":{"path":["nfse","eventos",":idNota",":protocolEvent"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"39a421a4-bb7e-46dc-a426-044f14483db4","description":{"content":"ID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"},{"id":"c6426b3b-e1be-44a0-9ece-a994ef272816","description":{"content":"Protocolo de evento gerado por nossa API, ao enviar uma solicitação de manifestação.
\n","type":"text/plain"},"type":"any","value":"string","key":"protocolEvent"}]}},"response":[{"id":"84ed7792-a3ae-4bc2-9850-385d381fcbd0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza uma solicitação de envio ou consulta de eventos por ID.
\nObservações:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"77e9c6f4-0990-4a71-af88-fc4dd9bc4cee","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta todos os eventos vinculados a nota.
\n","urlObject":{"path":["nfse","eventos",":idNota"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"Tipo do evento a ser consultado, por default irá retornar todos os eventos vinculados a nota.
\n","type":"text/plain"},"key":"tipoEvento","value":"manifestacao"}],"variable":[{"id":"32ea290d-94bc-427b-9856-d2af57885683","description":{"content":"ID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"b3750f77-2f85-470a-96d4-b3eb803d2a58","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta um eventos vinculados a nota por cpf/cnpj do autor, chave de acesso e protocolo.
\n","urlObject":{"path":["nfse","eventos",":cpfCnpj","chave",":chaveAcessoNfse",":protocolo"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"Tipo de ator referente ao CPF/CNPJ informado na requisição. Valores aceitos:
\n1 (prestador)
2 (tomador)
3 (intermediario)
Default: 2 (tomador)
CPF ou CNPJ do autor.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"},{"id":"e04239c6-2936-4e9e-b480-8ce07e247aa9","description":{"content":"Chave acesso da nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"chaveAcessoNfse"},{"id":"c26186b0-7274-4bda-aa17-9a353efe4c75","description":{"content":"Protocolo de um evento vinculado ao documento.
\n","type":"text/plain"},"type":"any","value":"string","key":"protocolo"}]}},"response":[{"id":"f3479c87-f01f-444a-9c2e-601a628335a8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Realiza uma solicitação de envio ou consulta de eventos por cpf/cnpj do autor e chave de acesso.
\nObservações:
\nTipo de ator referente ao CPF/CNPJ informado na requisição. Valores aceitos:
\n1 (prestador)
2 (tomador)
3 (intermediario)
Default: 2 (tomador)
CPF ou CNPJ do autor.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"},{"id":"8e20eff2-c6ab-4685-9186-ee4e1ffc70d0","description":{"content":"Chave acesso da nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"chaveAcessoNfse"}]}},"response":[{"id":"0b6b0c54-133c-4b75-9d17-822eaf524c9a","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta todos os eventos vinculados a nota por cpf/cnpj do autor e chave de acesso.
\n","urlObject":{"path":["nfse","eventos",":cpfCnpj","chave",":chaveAcessoNfse"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"Tipo do evento a ser consultado, por default irá retornar todos os eventos vinculados a nota.
\n","type":"text/plain"},"key":"tipoEvento","value":"manifestacao"},{"description":{"content":"Tipo de ator referente ao CPF/CNPJ informado na requisição. Valores aceitos:
\n1 (prestador)
2 (tomador)
3 (intermediario)
Default: 2 (tomador)
CPF ou CNPJ do autor.
\n","type":"text/plain"},"type":"any","value":"string","key":"cpfCnpj"},{"id":"fe34de06-cfff-4b40-8d92-f0d45901c83d","description":{"content":"Chave acesso da nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"chaveAcessoNfse"}]}},"response":[{"id":"e1917a95-5586-4f8f-96c2-6379a8ad9d6a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta de maneira resumida, os dados de uma nota já enviada por ID ou Protocolo.
\nObservações:
\nID ou protocolo gerado por nossa API, ao enviar uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNotaOrProtocol"}]}},"response":[{"id":"bdabd8c2-4d78-4bc4-9a9d-95841fd90f2d","name":"NOTA CONCLUIDO","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Consulta de maneira resumida, os dados de uma nota já enviada por ID Integração e CNPJ.
\nObservações:
\nCódigo único gerado por sua aplicação.
\n","type":"text/plain"},"type":"any","value":"string","key":"idIntegracao"},{"id":"b60088fd-8323-4d84-bfa3-189bc481e56e","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"f7a1a888-7a38-49a2-a518-41153b0dc2b4","name":"NOTA CONCLUIDO","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Retorna todas as notas enviadas em determinado período, de um cpfCnpj específico, independente de sua situação. Limitado a 25 registros por consulta, sendo necessário realizar a paginação através do campo hashProximaPagina.
\nTipos de consulta:
\nCenários de uso:
\nObservações:
\nCPF ou CNPJ da Empresa que deseja consultar.
\n","type":"text/plain"},"key":"cpfCnpj","value":"18187168000160"},{"description":{"content":"Período inicial de consulta.
\n","type":"text/plain"},"key":"dataInicial","value":"2020-09-01"},{"description":{"content":"Período final de consulta.
\n","type":"text/plain"},"key":"dataFinal","value":"2020-09-30"},{"description":{"content":"Hash da próxima nota para paginação;
\n","type":"text/plain"},"key":"hashProximaPagina","value":"604773edbeeb7d1d0c2dd7fa"}],"variable":[]}},"response":[{"id":"2b0cf309-b40f-46de-957e-d3fd58e56508","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Download do histórico de comunicação da NFS-e.
\n","urlObject":{"path":["nfse","historico",":idNota"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"c449bb17-2e83-4bb2-80c0-4e0903494235","description":{"content":"ID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"54d66ac2-42ec-4b7a-80b4-de77ca69365f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/zip"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Download do histórico de comunicação da NFS-e.
\n","urlObject":{"path":["nfse","historico",":idIntegracao",":cnpj"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"3475c3ca-f9f2-4158-9d2b-bb6240e42cf2","description":{"content":"Código único gerado por sua aplicação.
\n","type":"text/plain"},"type":"any","value":"string","key":"idIntegracao"},{"id":"a23c10f7-14ce-4cec-b439-d5c77bad042f","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"bfa2e6ca-5f41-4087-9f27-74bc16592ea6","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/zip"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Gera um relatório sintético de emissões de NFS-e, com todos os CNPJs vinculados a organização.
\nAtenção: O período informado não poderá ser superior a 31 dias
\n","urlObject":{"path":["nfse","relatorio"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"Data inicial do período para geração do relatório de emissões (Ex. 2023-03-01T00:00:00).
\n","type":"text/plain"},"key":"from","value":"string"},{"description":{"content":"Data final do período para geração do relatório de emissões (Ex. 2023-03-10T23:59:59).
\n","type":"text/plain"},"key":"to","value":"string"}],"variable":[]}},"response":[{"id":"cac96f24-1184-49d0-846f-0d57d2d429d1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Envio, ou reenvio de e-mail utilizando o ID da nota. Quando enviado \"reenvio\": true, enviaremos o email para todos os destinatários já inclusos no JSON da nota, e destinatários incluídos no ARRAY destinatarios.
\nCenários de uso:
\nObservações:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"2f031cbb-8179-43e6-b0d8-07e4e1b77c23","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Gera um relatório sintético de emissão de NFS-e para um CNPJ específico.
\nAtenção: O período informado não poderá ser superior a 31 dias
\n","urlObject":{"path":["nfse",":cnpj","relatorio"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[{"description":{"content":"Data inicial do período para geração do relatório de emissões (Ex. 2023-03-01T00:00:00).
\n","type":"text/plain"},"key":"from","value":"string"},{"description":{"content":"Data final do período para geração do relatório de emissões (Ex. 2023-03-10T23:59:59).
\n","type":"text/plain"},"key":"to","value":"string"}],"variable":[{"id":"00deb71a-6638-41dd-8df0-003a521a0336","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"aa7ddcf7-5917-42ca-b009-b7dba4d816de","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Resolve e sincronização de uma nota utilizando o ID.
\nCenários de uso:
\nObservações:
\nDownload do Recibo Provisório de Serviço.
\nObservação:
\nID gerado por nossa API, ao enviar ou receber uma nota.
\n","type":"text/plain"},"type":"any","value":"string","key":"idNota"}]}},"response":[{"id":"428ecbbc-d601-4d9c-ac9e-f5c20c7dc3e2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Download do Recibo Provisório de Serviço.
\nObservação:
\nCódigo único gerado por sua aplicação.
\n","type":"text/plain"},"type":"any","value":"string","key":"idIntegracao"},{"id":"bfd5d3f3-cc82-4a25-a63c-dc0859a6b5c5","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"}]}},"response":[{"id":"9b53db1d-c8f9-4053-af28-0e70512595c2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Diferente da maioria dos municípios, cujo envio de nota é feito por comunicação via WebService, algumas cidades adotaram o método UPLOAD, que consiste em pegar um arquivo formatado de acordo com as regras da prefeitura e fazer o upload desse arquivo diretamente no portal da própria prefeitura.
\n","urlObject":{"path":["nfse","upload",":protocolo"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"e3537503-7d9a-40ef-aff5-22e60e9b0b9d","type":"any","key":"protocolo"},{"id":"e904c007-1bb2-4939-8c03-9b1bf69bb8ac","description":{"content":"Protocolo retornado pela API no envio da nota
\n","type":"text/plain"},"type":"any","value":"string","key":"protocol"}]}},"response":[{"id":"c7575b0c-589a-49e7-8538-fca0d0015655","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/octet-stream"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Rota de consulta para verificar se há algum arquivo sendo processado com o protocolo enviado.
\n","urlObject":{"path":["nfse","governa","numeracao",":cnpj",":protocolo"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"cd152f57-9f4f-41d0-8b22-8a7c82626c69","description":{"content":"CNPJ da Empresa emitente/prestador.
\n","type":"text/plain"},"type":"any","value":"string","key":"cnpj"},{"id":"bf6f2045-5616-47f5-b38b-0994497ce254","type":"any","key":"protocolo"},{"id":"a56d84cd-e2f1-42d9-97be-e7a2eaa05b53","description":{"content":"Protocolo retornado pela API no envio do arquivo AIDF
\n","type":"text/plain"},"type":"any","value":"string","key":"protocol"}]}},"response":[{"id":"d03451fc-b2e7-439a-9a2f-a592d311c6d4","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/octet-stream"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Rota de envio de arquivo com AIDFs dos municípios do padrão Governa. A rotina comparará o último AIDF salvo no banco com a linha correspondente no arquivo enviado e salvará todos os números posteriores. Por isso, aconselha-se não modificar o arquivo recebido pelo portal da prefeitura. Municípios atuais: Araporã MG, Tupaciguara MG, Conceição das Lagoas MG, Carmo do Parnaíba MG, Iturama MG, Araxá MG, Valparaíso de Goiás MG, Patos de Minas MG. Mais detalhes de como adquirir o arquivo e fazer o processo, na documentação https://atendimento.tecnospeed.com.br/hc/pt-br/articles/360045099074 .
\n","urlObject":{"path":["nfse","governa","numeracao",""],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"b4ae131c-5cf5-4eff-befc-74a23c53ffb4","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Rota responsável por verificar o status de uma solicitação de interrupção de processamento de NFSe, utilizando o protocolo correspondente.
\n","urlObject":{"path":["nfse","interromper","status",":protocol"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[{"id":"c2bef44f-d3fa-45f6-82fc-79dba17fe8ab","description":{"content":"ID gerado pela API no envio da solicitação de interrompimento de notas
\n","type":"text/plain"},"type":"any","value":"2e31e63a-006d-46d2-9a7a-216d39abae6e","key":"protocol"}]}},"response":[{"id":"b2c69892-74ae-459b-a7c8-5c2e4d27b1e3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"Rota responsável por enviar uma lista de NFSe que ainda não estão em situação final, solicitando a interrupção do seu processamento. Para mais detalhes consulte a documentação.
\n","urlObject":{"path":["nfse","interromper"],"host":["https://api.sandbox.plugnotas.com.br"],"query":[],"variable":[]}},"response":[{"id":"fcd0fd67-02a9-4e08-8ee1-9d644517f769","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"