PlugNotas

O Plasfran ERP utiliza a API REST do PlugNotas para facilitar a emissão de documentos fiscais eletrônicos NFS-e. Essa integração permite que o sistema envie as informações necessárias em formato JSON, e o PlugNotas se encarrega de todo o processo de comunicação com as prefeituras e órgãos fiscais competentes.

---

Visão Geral

• Envio de Dados: O Plasfran ERP envia um JSON estruturado com os dados da nota fiscal.

• Processamento: O PlugNotas gera o XML, assina digitalmente e envia para autorização junto à prefeitura ou SEFAZ.

• Retorno: Após a autorização, o PlugNotas retorna os documentos fiscais (XML e PDF) e notifica o sistema via Webhook.

Funcionalidades integradas:

• Emissão de NFS-e (Nota Fiscal Serviço)
• Consulta de status e situação
• Cancelamento de notas
• Download de XML/PDF

---

1. Certificado

Endpoint
GET /certificado

Descrição
Lista todos os certificados vinculados a sua organização.

Endpoint
POST /certificado

Descrição
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 subir várias vezes o mesmo certificado, um mesmo ID pode ser vinculado a diversas empresas.

Endpoint
PUT /certificado/{idCertificado}

Descrição
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.

Endpoint
GET /certificado/{idCertificadoOrCpfCnpj}

Descrição
Utilize para buscar os dados de um certificado específico já cadastrado

Endpoint
DELETE /certificado/{idCertificado}

Descrição
Utilize para deletar um certificado específico já cadastrado

---

2. Empresa

Endpoint
GET /empresa

Descrição
Lista todas as Empresas vinculadas a sua organização, com um limite de 150 registros por paginação.

Endpoint
POST /empresa

Descrição
Cadastra e vincule uma nova Empresa (emitente/prestador) a sua organização.

Endpoint
PATCH /empresa/{cnpj}

Descrição
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.

Endpoint
GET /empresa/{cnpj}

Descrição
Consulta o cadastro de um CNPJ (emitente/prestador), que esteja vinculado a sua organização.

3. Tomador

Endpoint
POST /nfse/tomador

Descrição
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. { ... "tomador": { "id": "abc123" } ... }

Endpoint
PATCH /nfse/tomador/{cpfCnpj}

Descrição
Para atualizar dados de um tomador já cadastrado.

Endpoint
GET /nfse/tomador/{cpfCnpj}

Descrição
Consulta os dados de um tomador já cadastrado.

Endpoint
DELETE /nfse/tomador/{cpfCnpj}

Descrição
Para excluir dados de um tomador já cadastrado.

3. NFSe

Endpoint
POST /nfse

Descrição
Nesta etapa, será realizada uma validação de esquema do JSON, e de algumas regras de negócio, se tudo estiver OK, o ERP receberá um ID para cada nota enviada, em seguida, a NFSe será enviada para a Prefeitura.

Endpoint
GET /nfse/{idNotaOrProtocol}

Descrição
Consulta dados das notas a partir de seu ID ou protocolo.

Endpoint
POST /nfse/cancelar/{idNota}

Descrição
Realiza uma solicitação de cancelamento de NFS-e por ID.

Endpoint
GET /nfse/cancelar/status/{cancellationProtocol}

Descrição
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.

Endpoint
GET /nfse/pdf/{idNota}

Descrição
Download da impressão em PDF da NFS-e por ID.

Endpoint
GET /nfse/xml/{idNota}

Descrição
Download do XML da NFS-e por ID.

4. Relatório de consumo

Endpoint
GET /relatorio/{ano}/{mes}

Descrição
Gera um relatório sintético de todas as NFS-e, emitidas por CNPJs vinculados à organização.

5. Webhook

Endpoint
GET /webhook

Descrição
Consulta o webhook configurado para a organização.

Endpoint
POST /webhook

Descrição
Configura um webhook geral para toda a organização.

Endpoint
PUT /webhook

Descrição
Altera as configurações do webhook vinculado a organização.

Endpoint
DELETE /webhook

Descrição
Remove o webhook vinculado a organização.

Documentação oficial PlugNotas

https://docs.plugnotas.com.br/

---