Pular para o conteúdo principal

Documentação Técnica - Padrão AGILI

Henrique Bassi
Atualizado

Esta documentação reúne as regras e os recursos do padrão AGILI utilizados na emissão integrada de NFS-e, com foco em manual do web service, ambientes disponíveis, autenticação por chave digital, métodos de emissão, consulta e cancelamento, uso no PlugNotas, ManagerEdoc/ManagerSaaS e Componente NFSe, além de orientações sobre XML/RPS/TX2, erros comuns, campos customizados de impressão e pontos que dependem de validação interna. Consulte este manual principalmente se você é:

  • Cliente/integrador (dev/tech lead): para entender ambientes, autenticação por certificado, fluxo (DPS → NFS-e), métodos e pontos de atenção.

Tópicos deste artigo

 

Manual de integração com o webservice

  • Manual de integração com o web service: apresenta a estrutura técnica do padrão AGILI, incluindo tecnologia de comunicação, autenticação por chave digital, definição dos serviços, padrões de tráfego XML e tipos de dados aceitos.
  • Download do manual

 

Portais Disponíveis

  • Produção

Métodos disponíveis

Emissão

  • Envio sequencial: ( ) Necessita (X) Não necessita

  • Modo: (X) Síncrono ( ) Assíncrono ( ) Ambos

  • Lote: ( ) Aceita lote (X) Não aceita lote 

Consulta

  • ( ) Consulta de lote

  • (X) Consulta por RPS

  • (X) Consulta por NFS-e

  • ( ) Consulta por protocolo

  • ( ) Consulta notas tomadas

  • ( ) Consulta por período

Cancelamento / Eventos

  • (X) Cancelamento via web service

  • ( ) Cancelamento administrativo

Para cancelar uma NFS-e, o motivo de cancelamento e o código de cancelamento são obrigatórios. Quando esses dados não são informados, o preenchimento automático utiliza o motivo “NFSe cancelada a pedido do prestador” e o código 2 – Serviço não prestado. Os códigos de cancelamento aceitos são:

  • 1 – Erro na emissão

  • 2 – Serviço não prestado

Tipo de impressão

  • ( ) Impressão via link da prefeitura
    Os produtos fazem download do PDF gerado pela prefeitura.

  • (X) Impressão via layout Tecnospeed
    Os produtos geram o PDF, aproximando ao máximo o layout da prefeitura.

Importante: o tipo de impressão depende do que o padrão permite. Não é possível editar livremente o layout além das opções suportadas pelo produto/padrão.

Observações gerais

  • É necessário preencher o parâmetro Senha nas configurações de autenticação da prefeitura com a chave digital de web service gerada no portal da prefeitura.

  • O XML do envio síncrono não possui identificação dos campos referentes ao RPS, como número do RPS, série e tipo.

  • O padrão trabalha com comunicação em HTTP, utilizando requisições POST com XML no corpo da requisição e retorno também em XML.

  • A autenticação das operações do web service é feita por meio de uma chave digital, enviada nas solicitações XML e validada junto à base do município.

  • A chave digital é disponibilizada ao prestador por meio do sistema da administração pública municipal.

Geração do XML - Campos importantes

  • O código do serviço segue o que está descrito na LC-116.
  • O campo CodigoTributacaoMunicipio pode ser informado, entretanto, não é obrigatório para a autorização de notas.
  • Ao gerar o XML os acentos estavam sendo trocados pelo caractere '?', portanto foi removido os acentos.

Emissão pelo PlugNotas

  • A chave digital deverá ser informada no parâmetro "Senha", nas configurações de autenticação com a prefeitura.

Exemplo de configuração da chave digital pela interface do PlugNotas

 

 Exemplo de configuração da chave digital pela API

 

Emissão pelo ManagerEdoc/ManagerSaaS

  • ​A chave digital deve ser informado no campo Senha na aba Configurações > Autenticação da Prefeitura.

Exemplo de configuração da chave digital:

 

Emissão pelo Componente NFSe

  • Nos testes realizados com o Delphi 7 e modo debug, foi encontrado um problema ao fazer a requisição para o Webservice do padrão. A exceção levantada traz a mensagem "Invalid argument to date Encode". Apesar de disparar a exceção, a requisição é feita corretamente e não foi possível tratá-la, pois é referente a um problema conhecido do Indy, utilizado para fazer a requisição.
  • A chave digital deve ser informado no parâmetro extra "Senha".

Exemplo de configuração da chave digital:

NFSe.ParametrosExtras = "Senha=999512b599abc9babc9a9bc99abc999c";

 

Erros comuns

  • Erro ao tentar gerar NFS-e => Referência de objeto não definida para uma instância de um objeto.
    Poderá ocorrer quando algum campo for enviado de forma incorreta, exemplo do campo: CodigoItemListaServico.
     
  • E26-Modelo de RPS informado não encontrado na base de dados para o prestador do serviço. (Corrija a série e/ou tipo do RPS informado ou entre em contato com a administração pública municipal para solicitar o cadastro do modelo de RPS.)
    É necessário confirmar se há algum modelo de RPS cadastrado no portal do prestador e realizar o envio da nota com a respectiva série, caso não haja modelos cadastrados é necessário inserir um novo.

Campos customizados para a impressão

Impressão do RPS

  • RazaoSocialPrestador=String[80]
  • NomeFantasiaPrestador=String[80]
  • EnderecoPrestador=String[80]
  • TelefonePrestador=String[80]
  • EmailPrestador=String[80]
  • ValorTotalDescontos=String[10]
  • NaturezaOperacao=String[80]
  • ValorUnitarioServico=String[20]

Impressão da NFSe

  • DataEmissaoNFSeSubstituida=String[20]
  • NumeroProcesso=String[20]
  • EnderecoPrestador=String[80]
  • NaturezaOperacao=String[80]
  • ValorUnitarioServico=String[20]

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.