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

Esta documentação reúne as regras e os recursos do padrão ABASE20 utilizados na emissão integrada de NFS-e, com foco em ambientes, autenticação, métodos disponíveis, uso no PlugNotas e no Componente NFSe, além de orientações sobre XML/DPS, erros comuns, arquivos de exemplo, campos customizados de impressão e pontos que ainda dependem de validação interna. Consulte este manual principalmente se você é:

• Cliente/integrador (dev/tech lead): para entender ambientes, autenticação, fluxo de envio, consultas, limitações conhecidas e pontos de atenção na integração.

Tópicos deste artigo

• Manual do web service

• Portais disponíveis

• Métodos disponíveis

• Tipo de impressão

• Observações gerais do padrão

• Observações específicas por município

• Observações sobre a geração do XML/DPS

• Campos disponibilizados para adequação da Reforma Tributária

• Emissão pelo PlugNotas

• Emissão pelo Manager Saas

• Emissão pelo Componente NFSe

• Campos customizados para impressão

• Exemplos de arquivos de integração

Manual do web service

• Download do manual
• Documentação Swagger

Portais disponíveis

• Produção
• Homologação

Métodos disponíveis

Emissão

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

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

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

O padrão ABASE20 documenta recepção individual de DPS e recepção de lote, ambas com processamento assíncrono. A DPS deve possuir numeração sequencial crescente.

Consulta

• (X) Consulta de lote

• ( ) Consulta por RPS

• ( ) Consulta por NFS-e

• (X) Consulta por protocolo

• ( ) Consulta notas tomadas

• ( ) Consulta por período

• (X) Consulta da NFS-e pelo identificador da DPS

A consulta do processamento ocorre pelo protocolo retornado no envio. Já a consulta da NFS-e utiliza o identificador da DPS informado no XML. 

Identificador da DPS é formado por: "DPS" +
Código do Município (IBGE - 7 posições) +
Tipo de Inscrição Federal (1 posição) +
CPF/CNPJ do Prestador (14 posições) +
Série da DPS (5 posições) +
Número da DPS (15 posições)
Exemplo: DPS+4316006+2+29062609000177+00001+000000000001209
Consultar NFSe por: DPS431600622906260900017700001000000000001209

Cancelamento / Eventos

• (X) Cancelamento de NFS-e via web service

• ( ) Cancelamento administrativo

• ( ) Possui eventos específicos

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 do padrão

• O padrão necessita de um token de autenticação que, na integração TecnoSpeed, deve ser informado nos parâmetros extras como Senha. Para clientes SaaS/PlugNotas, a orientação atual é informar esse valor no campo Senha da Prefeitura.

• Para gerar o token deve-se seguir a documentação Guia para Solicitação do Token para integração com a API NFS-e Nacional

• O padrão não suporta quebra de linha.

• Para consultar a NFS-e é necessário informar o identificador da DPS, que existe no XML de envio. Por isso, clientes do componente precisam controlar esse identificador em seu sistema.

Observações específicas por município

• [NÃO HÁ INFORMAÇÕES CONSOLIDADAS POR MUNICÍPIO]

Observações sobre a geração do XML/DPS

• O código do serviço segue o padrão nacional descrito na LC-116.

• O layout do XML segue o modelo nacional adotado pelo provedor.

• O identificador da DPS deve ser preservado, pois ele é utilizado na consulta posterior da NFS-e.

Campos disponibilizados para adequação da Reforma Tributária

Observação: Campos obrigatórios conforme o arquivo de esquema do Padrão estão destacados em negrito.

Ressaltamos que, para manter a funcionalidade em ambos os ambientes de emissão (produção e homologação), essas regras de validação ainda não foram aplicadas em nossas aplicações.

Para maiores informações sobre a forma de preenchimento destes campos novos, acesse nossa documentação do Padrão Unificado de TX2.

Emissão pelo PlugNotas

Conteúdo voltado para quem usa PlugNotas.

Documentação completa do produto: docs.plugnotas.com.br

Autenticação

• No painel PlugNotas acesse o menu Empresas para cadastrar ou editar algum cadastro já realizado.
  Em seguida selecione a guia NFS-e: 
  Obs.: Caso não esteja aparecendo a guia NFS-e será necessário acessar Documentos Ativos para habilitar a mesma.
• 
  
   
• Na guia NFS-e, localize a área Autenticação Prefeitura, onde deverá ser preenchido os campos de acordo com a definição de cada Padrão de WebService.
   
•           Exemplo: Abaixo trata-se dos dados de Autenticação prefeitura definidos para o padrão
            ABASE20 onde é necessário informar apenas o campo Senha:
  
  

Exemplo de configuração pela API

Emissão pelo Manager Saas

Conteúdo voltado para quem usa Manager Saas.

Documentação completa do produto: https://atendimento.tecnospeed.com.br/hc/pt-br/sections/4422795883287-Nota-de-servi%C3%A7o-NFS-e

Autenticação

• Deve ser informado no painel ManagerSaaS no menu Configurações → Autenticação da prefeitura

Emissão pelo Componente NFSe

Conteúdo voltado para quem usa Componente NFS-e V2.

Documentação completa do produto:https://atendimento.tecnospeed.com.br/hc/pt-br/sections/4422773785623-Componente-NFS-e-V2

Autenticação

• Os dados de Autenticação prefeitura deverão ser informadas no parâmetro extra  "Senha" como definidos pelo padrão ABASE20:

NFSe.ParametrosExtras = "Senha=1234BC2";

Campos customizados para impressão

Impressão do RPS

• RazaoSocialPrestadorCustom=String[80]

• EnderecoPrestadorCustom=String[80]

• CodigoMunicipioPrestador=String[10]

• NumeroPrestadorCustom=String[7]

• ComplementoPrestadorCustom=String[20]

• BairroPrestadorCustom=String[40]

• CepPrestadorCustom=String[8]

• TelefonePrestadorCustom=String[20]

• EmailPrestadorCustom=String[80]

• MunicipioIncidencia=String[7]

• ValorBaseCalculo=String[15]

• ValorDeducoesCustom=String[15]

• ValorIss=String[15]

• AliquotaIss=String[15]

• IssRetido=String[1]

• ExigibilidadeISS=String[2]

• CodigoTributacaoMunicipio=String[10]

Impressão da NFS-e

• CodigoVerificacao=String[25]

• ValorCofinsImportacao=String[20]

• ValorCIDE=String[20]

• ValorICMS=String[20]

• ValorIOF=String[20]

• ValorIPI=String[20]

• ValorPisImportacao=String[20]

• InscricaoEstadualTomador=String[80]

• InscricaoEstadualPrestador=String[80]

• IssRetido=String[2]

• ExigibilidadeISS=String[2]

• CodigoTributacaoMunicipio=String[10]

Exemplos de arquivos de integração