PHPackages                             codephix/plugnotas - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. codephix/plugnotas

ActiveLibrary

codephix/plugnotas
==================

Pacote para utilização do Plugnotas em PHP

1.1(2y ago)016MITPHPPHP >=7.0

Since Oct 6Pushed 2y agoCompare

[ Source](https://github.com/codephix/plugnotas-php)[ Packagist](https://packagist.org/packages/codephix/plugnotas)[ RSS](/packages/codephix-plugnotas/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (5)Versions (3)Used By (0)

[![Build Status](https://camo.githubusercontent.com/b437db06d55b04af148422ebc83f62ec853f33e604854165d5ecf22b5aff126b/68747470733a2f2f7472617669732d63692e6f72672f7465636e6f73706565642f706c75676e6f7461732d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/tecnospeed/plugnotas-php) [![codecov](https://camo.githubusercontent.com/8bcde52e74a6bb60448a7ff594abc3c86ec3abb950de6e27fb29a65bd7938467/68747470733a2f2f636f6465636f762e696f2f67682f7465636e6f73706565642f706c75676e6f7461732d7068702f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/tecnospeed/plugnotas-php)

Plugnotas
=========

[](#plugnotas)

Este pacote foi construído com o objetivo de simplificar a integração com a API do [Plugnotas](https://plugnotas.com.br). Para 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).

Instalação
----------

[](#instalação)

### Adicionando o pacote

[](#adicionando-o-pacote)

Aconselhamos 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.

O pacote pode ser adicionado utilizando o comando do próprio composer:

```
php composer.phar require tecnospeedsa/plugnotas:~1.4

```

Ou adicionado manualmente no arquivo `composer.json`:

```
{
  "require": {
    "tecnospeedsa/plugnotas": "~1.4"
  }
}

```

O carregamento do pacote é realizado com o autoloader do Composer, caso você não tenha adicionado ao seu projeto é necessário incluir o seguinte require:

```
require 'vendor/autoload.php;'

```

Para 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).

Utilizando o pacote
-------------------

[](#utilizando-o-pacote)

### Envio de NFSe

[](#envio-de-nfse)

Para 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.

Uma 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.

Um 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).

### Criando uma NFSe com o auxiliar de builder

[](#criando-uma-nfse-com-o-auxiliar-de-builder)

A classe `TecnoSpeed\Plugnotas\Builders\NfseBuilder` é uma classe auxiliar que permite você criar de forma fácil um objeto `TecnoSpeed\Plugnotas\Nfse`.

Com 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).

### Cadastro de Prestador, Tomador e Serviço

[](#cadastro-de-prestador-tomador-e-serviço)

O 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.

Nos links a seguir você encontra exemplos dos cadastros dos tipos:

- [Cadastro de Prestador](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.prestador.create.php)
- [Cadastro de Tomador](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.tomador.create.php)
- [Cadastro de Serviço](https://github.com/tecnospeed/plugnotas-php/blob/master/examples/nfse.servico.create.php)

### Consultando uma NFSe

[](#consultando-uma-nfse)

Para 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`.

Apó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`.

Exemplo 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).

### Download do PDF de uma NFSe

[](#download-do-pdf-de-uma-nfse)

Da 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`. Uma particularidade é que é necessário indicar a pasta para escrita dos arquivos no objeto de configuração utilizando o método `setNfseDownloadDirectory`.

Existe 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`.

Os 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:

- Quando utilizado o método `download`: `/.pdf`
- Quando utilizado o método `downloadPdfByCnpjAndIdIntegracao`: `/-.pdf`

[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).

### Cancelamento

[](#cancelamento)

O 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.

Da 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`.

Os respectivos métodos para realizar este procedimento são: `cancel` e `cancelByCnpjAndIdIntegracao`.

Ao criar um cancelamento será retornado um protocolo, tal protocolo pode ser utilizado para consultar o status do cancelamento utilizando a rota `cancelStatus`.

### Exemplos

[](#exemplos)

Você pode conferir alguns exemplos na pasta `/examples`.

[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).

Documentações oficiais
----------------------

[](#documentações-oficiais)

- [Site do Plugnotas](https://plugnotas.com.br/)
- [Documentação oficial](https://atendimento.tecnospeed.com.br/hc/pt-br/categories/360001354313-Plugnotas)
- [Documentação da API](https://docs.plugnotas.com.br/)

Changelog
---------

[](#changelog)

Acesse o [Changelog da aplicação por este link](https://github.com/tecnospeed/plugnotas-php/blob/master/CHANGELOG.md).

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 89.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

953d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/26178315?v=4)[CodePhix](/maintainers/codephix)[@codephix](https://github.com/codephix)

---

Top Contributors

[![ferfabricio](https://avatars.githubusercontent.com/u/697486?v=4)](https://github.com/ferfabricio "ferfabricio (62 commits)")[![codephix](https://avatars.githubusercontent.com/u/26178315?v=4)](https://github.com/codephix "codephix (3 commits)")[![ribeiro-thiago](https://avatars.githubusercontent.com/u/7726580?v=4)](https://github.com/ribeiro-thiago "ribeiro-thiago (3 commits)")[![guiihdourado](https://avatars.githubusercontent.com/u/8441209?v=4)](https://github.com/guiihdourado "guiihdourado (1 commits)")

---

Tags

nfseTecnospeedplugnotasdocumentos fiscais

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/codephix-plugnotas/health.svg)

```
[![Health](https://phpackages.com/badges/codephix-plugnotas/health.svg)](https://phpackages.com/packages/codephix-plugnotas)
```

###  Alternatives

[tecnospeedsa/plugnotas

Pacote para utilização do Plugnotas em PHP

2226.6k](/packages/tecnospeedsa-plugnotas)[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k21](/packages/neuron-core-neuron-ai)[nfse-nacional/nfse-php

This is my package nfse

1271.2k](/packages/nfse-nacional-nfse-php)[lucas-simoes/php-nfse

API para geração e comunicação da NFSe com as Prefeituras. Este é um fork do projeto nfephp-org/sped-nfse que foi descontinuado

572.3k](/packages/lucas-simoes-php-nfse)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)