{"id":36253629,"url":"https://github.com/tecnospeed/plugnotas-php","last_synced_at":"2026-01-11T07:03:34.271Z","repository":{"id":46184097,"uuid":"170910915","full_name":"tecnospeed/plugnotas-php","owner":"tecnospeed","description":"Pacote para integração com o Plugnotas","archived":false,"fork":false,"pushed_at":"2023-05-04T20:08:02.000Z","size":159,"stargazers_count":22,"open_issues_count":21,"forks_count":19,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-22T19:55:42.396Z","etag":null,"topics":["cte","nfce","nfe","nfse","php","sefaz","tecnospeed"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tecnospeed.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-15T18:33:53.000Z","updated_at":"2024-11-25T20:59:38.000Z","dependencies_parsed_at":"2022-09-23T06:00:55.002Z","dependency_job_id":null,"html_url":"https://github.com/tecnospeed/plugnotas-php","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/tecnospeed/plugnotas-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecnospeed%2Fplugnotas-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecnospeed%2Fplugnotas-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecnospeed%2Fplugnotas-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecnospeed%2Fplugnotas-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tecnospeed","download_url":"https://codeload.github.com/tecnospeed/plugnotas-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecnospeed%2Fplugnotas-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28296941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T04:44:51.577Z","status":"ssl_error","status_checked_at":"2026-01-11T04:44:44.232Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cte","nfce","nfe","nfse","php","sefaz","tecnospeed"],"created_at":"2026-01-11T07:03:34.206Z","updated_at":"2026-01-11T07:03:34.262Z","avatar_url":"https://github.com/tecnospeed.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/tecnospeed/plugnotas-php.svg?branch=master)](https://travis-ci.org/tecnospeed/plugnotas-php) [![codecov](https://codecov.io/gh/tecnospeed/plugnotas-php/branch/master/graph/badge.svg)](https://codecov.io/gh/tecnospeed/plugnotas-php)\n\n# Plugnotas\n\nEste pacote foi construído com o objetivo de simplificar a integração com a API do [Plugnotas](https://plugnotas.com.br).\nPara obter informações sobre o funcionamento e contratações acesse [nosso site](https://plugnotas.com.br) ou a [documentação oficial](https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313-Plugnotas).\n\n## Instalação\n\n### Adicionando o pacote\n\nAconselhamos a instalação do pacote pelo [Composer](https://getcomposer.org). Composer é um gerenciador de dependências para PHP que lhe permite declarar e instalar as dependências em seu projeto de forma simplificada.\n\nO pacote pode ser adicionado utilizando o comando do próprio composer:\n\n```\nphp composer.phar require tecnospeedsa/plugnotas:~1.4\n```\n\nOu adicionado manualmente no arquivo `composer.json`:\n\n```\n{\n  \"require\": {\n    \"tecnospeedsa/plugnotas\": \"~1.4\"\n  }\n}\n```\n\nO carregamento do pacote é realizado com o autoloader do Composer, caso você não tenha adicionado ao seu projeto é necessário incluir o seguinte require:\n\n```\nrequire 'vendor/autoload.php;'\n```\n\nPara maiores informações de como instalar, utilizar e melhores práticas para definir dependências em seu projeto acesse o site oficial [getcomposer.org](https://getcomposer.org).\n\n## Utilizando o pacote\n\n### Envio de NFSe\n\nPara enviar uma NFSe deve ser criado um objeto do tipo relacionado (`TecnoSpeed\\Plugnotas\\Nfse`), o qual é composto de vários outros objetos agrupados dentro de seu namespace.\n\nUma vez o objeto criado deve-se chamar o método `send` do mesmo, este processo pode ser bem complexo e extenso, não se preocupe existe uma forma mais fácil citada a seguir.\n\nUm exemplo do [envio de uma NFSe criando os objetos de forma manual pode ser encontrado aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.full.php).\n\n### Criando uma NFSe com o auxiliar de builder\n\nA classe `TecnoSpeed\\Plugnotas\\Builders\\NfseBuilder` é uma classe auxiliar que permite você criar de forma fácil um objeto `TecnoSpeed\\Plugnotas\\Nfse`.\n\nCom esta classe auxiliar utilizando os métodos: `withTomador`, `withPrestador`, `withServico`, `withRps`, `withImpressao` e `withCidadePrestacao` você pode compor o objeto Nfse, [um exemplo disso é mostrado no arquivo nfse.simple.php](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.simple.php).\n\n### Cadastro de Prestador, Tomador e Serviço\n\nO cadastro de Prestador, Tomador e Serviço simplifica o envio da NFSe, sendo que uma vez cadastrado você pode enviar a nota com menos parâmetros pois o que já tem cadastrado será consultado.\n\nNos links a seguir você encontra exemplos dos cadastros dos tipos:\n\n- [Cadastro de Prestador](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.prestador.create.php)\n- [Cadastro de Tomador](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.tomador.create.php)\n- [Cadastro de Serviço](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.servico.create.php)\n\n### Consultando uma NFSe\n\nPara consultar uma NFSe é necessário criar um objeto do tipo `TecnoSpeed\\Plugnotas\\Configuration`, setar ele num novo objeto `TecnoSpeed\\Plugnotas\\Nfse` utilizando o método `setConfiguration`.\n\nApós este setup realizado, existe duas possibilidades de consulta, pelo ID da nota ou protocolo gerado na hora que você enviou a nota, ou passando o ID Integração e o CNPJ do Prestador utilizado para criar a NFSe. Os respectivos métodos são: `findByCnpjAndIdIntegracao` e `findByIdOrProtocol`.\n\nExemplo utilizando o [método findByCnpjAndIdIntegracao pode ser encontrado aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.consulta.cnpjId.php) e [exemplo utilizando o método findByIdOrProtocol pode ser encontrado aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.consulta.cnpjId.php).\n\n### Download do PDF de uma NFSe\n\nDa mesma forma que a consulta o download do PDF da Nfse necessita de um objeto do tipo `TecnoSpeed\\Plugnotas\\Configuration`, o qual deve ser setado num novo objeto `TecnoSpeed\\Plugnotas\\Nfse` utilizando o método `setConfiguration`.\nUma particularidade é que é necessário indicar a pasta para escrita dos arquivos no objeto de configuração utilizando o método `setNfseDownloadDirectory`.\n\nExiste a possibilidade de realizar o download utilizando o ID da nota retornado na criação utilizando o método `download`, como também realizar o download utilizando o CNPJ do Prestador e o ID Integração utilizados no envio da NFSe através do método `downloadPdfByCnpjAndIdIntegracao`.\n\nOs arquivos serão salvos na pasta configurada (a qual precisa ter permissão de escrita), o padrão do nome do arquivo será o seguinte:\n\n- Quando utilizado o método `download`: `\u003cpasta informada\u003e/\u003cid\u003e.pdf`\n- Quando utilizado o método `downloadPdfByCnpjAndIdIntegracao`: `\u003cpasta informada\u003e/\u003ccnpj\u003e-\u003cid integração\u003e.pdf`\n\n[Exemplo de download utilizando o ID pode ser encontrado aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.download.php) e [exemplo de download utilizando o CNPJ e ID Integração aqui](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.download.cnpjId.php).\n\n### Cancelamento\n\nO cancelamento de uma NFSe pode ser realizado da mesma forma com que a busca e o download, informando o ID da Nfse ou o Cnpj do prestador e o ID Integração.\n\nDa mesma forma que a consulta e o download do PDF da Nfse é necessário de um objeto do tipo `TecnoSpeed\\Plugnotas\\Configuration`, o qual deve ser setado num novo objeto `TecnoSpeed\\Plugnotas\\Nfse` utilizando o método `setConfiguration`.\n\nOs respectivos métodos para realizar este procedimento são: `cancel` e `cancelByCnpjAndIdIntegracao`.\n\nAo criar um cancelamento será retornado um protocolo, tal protocolo pode ser utilizado para consultar o status do cancelamento utilizando a rota `cancelStatus`.\n\n### Exemplos\n\nVocê pode conferir alguns exemplos na pasta `/examples`.\n\n[Todos os objetos decompostos em arrays podem ser vistos no arquivo nfse.array.php](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.array.php).\n\n## Documentações oficiais\n\n- [Site do Plugnotas](https://plugnotas.com.br/)\n- [Documentação oficial](https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313-Plugnotas)\n- [Documentação da API](https://docs.plugnotas.com.br/)\n\n## Changelog\n\nAcesse o [Changelog da aplicação por este link](https://github.com/tecnospeed/plugnotas-php/blob/master/CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftecnospeed%2Fplugnotas-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftecnospeed%2Fplugnotas-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftecnospeed%2Fplugnotas-php/lists"}