Projeto Nota Fiscal Eletrônica de Alienação de Bens Imóveis

Manual de Orientação ao Contribuinte

NF-e ABI Receita Estadual do Paraná

Manual de Orientação ao Contribuinte da Nota Fiscal Eletrônica de Alienação de Bens Imóveis

Esta página apresenta o conteúdo técnico da Visão Geral da NF-e ABI, versão 1.00, e os trechos pertinentes do Anexo I - Leiaute e Regras de Validação, versão 1.00. O MOC Online é material de apoio e não substitui os documentos oficiais.

1. Introdução

Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para a integração entre os sistemas da Administração Tributária e os sistemas de informações dos contribuintes emissores de NF-e de Alienação de Bens Imóveis.

A versão original do Manual e as Notas Técnicas que o atualizam podem ser encontradas no Portal da NF-e ABI da SVRS, onde também se encontram os pacotes de liberação de schemas e demais documentos.

O Manual de Orientação do Contribuinte é composto pelos seguintes documentos:

  • MOC - Visão Geral NF-e ABI;
  • MOC - Anexo I - Leiaute e Regras de Validação da NF-e ABI.

2. Considerações Iniciais

A NF-e de Alienação de Bens Imóveis (NF-e ABI) é o documento emitido e armazenado eletronicamente, de existência apenas digital, cuja validade jurídica é garantida pela assinatura digital do emitente e autorização de uso pelo ambiente nacional da NF-e ABI.

2.1. Objetivos do Projeto

O Projeto NF-e ABI tem como objetivo a implantação de um modelo nacional de documento fiscal eletrônico, identificado pelo modelo 77, visando atender à Lei Complementar 214/2025, com validade jurídica garantida pela assinatura digital do emitente.

2.2. Conceitos

2.2.1. NF-e ABI (Modelo 77)

A NF-e ABI é um documento de existência exclusivamente digital, emitido e armazenado eletronicamente, com o intuito de documentar uma operação sujeita ao IBS/CBS.

2.2.2. Chave de Acesso

A Chave de Acesso de identificação da NF-e ABI é um conjunto de 44 caracteres numéricos, formado pela concatenação de campos que se encontram no leiaute da NF-e, seguindo a estrutura apresentada na Tabela 2-1.

Tabela 2-1 - Chave de Acesso da NF-e ABI
PosiçãoInformaçãoCaracteresCampoId
1Código da UF do emitente do Documento Fiscal02cUFB02
2Ano e Mês de emissão da NF-e04AAMMExtraídos de B07
3CNPJ/CPF do emitente14CNPJ/CPFC02/C03
4Modelo do Documento Fiscal02modB04
5Série do Documento Fiscal03serieB05
6Número do Documento Fiscal09nNFB06
7Forma de emissão da NF-e ABI01tpEmisB14
8Site do Autorizador que recepcionou a NF-e ABI01nSiteAutorizB15
9Código Numérico que compõe a Chave de Acesso07cNFB03
10Dígito Verificador da Chave de Acesso01cDVB16
Código da UFAAMM da emissãoCNPJ do EmitenteModelo (mod)Série (serie)Número da NF-e ABIForma de emissãoSite Autoriz.Código NuméricoDV
Quantidade de Caracteres02041402030901010701

O Dígito Verificador (DV) irá garantir a integridade da chave de acesso, protegendo-a principalmente contra digitações erradas.

O cálculo do Dígito Verificador da Chave de Acesso da NF-e ABI deverá respeitar o mesmo cálculo feito para os demais documentos fiscais eletrônicos, conforme a DFe NTCJ 2025.001_CNPJ Alfa_v1.00.

2.2.3. Chave Natural

A identificação única de uma nota fiscal para efeitos tributários é feita pelos seguintes conjuntos de informações, que são um subconjunto das informações existentes na chave de acesso:

  • NF-e ABI: UF, CNPJ ou CPF do emitente, série e número da NF-e, modelo do documento fiscal eletrônico, ambiente de autorização e site de autorização.

Estes subconjuntos recebem a denominação de “chave natural”.

O Sistema de Autorização de Uso valida a existência de uma NF-e ABI previamente autorizada e rejeita novos pedidos de autorização para NF-e ABI caso seja identificada duplicidade de Chave Natural.

2.2.4. Responsável Técnico

Responsável Técnico é a empresa desenvolvedora ou a empresa responsável tecnicamente pelo sistema (software) de emissão utilizado pelo emitente. Essa informação será utilizada pelas Administrações Tributárias.

Em caso de sistema de emissão de NF-e ABI de desenvolvimento próprio, o responsável técnico é o próprio emitente.

2.3. Descrição Simplificada do Modelo Operacional da NF-e ABI

2.3.1. Autorização de Uso

O emissor da NF-e ABI gera um arquivo eletrônico contendo as informações da operação, o qual deverá ser assinado digitalmente, transformando este arquivo em um documento eletrônico nos termos da legislação brasileira, de maneira a garantir a integridade dos dados e a autoria do emissor.

Este arquivo eletrônico será transmitido pela Internet para a Administração Tributária, que, após verificar a integridade formal, devolverá um protocolo de recebimento denominado “Autorização de Uso”.

Após a Autorização de Uso, que transforma o documento eletrônico no Documento Fiscal denominado NF-e ABI, a Administração Tributária disponibilizará consulta, através da Internet, para o adquirente e outros legítimos interessados que conheçam a chave de acesso do documento eletrônico.

2.3.2. Modalidades de Emissão

Em um cenário de falha que impossibilite a emissão da NF-e ABI na modalidade normal, o emissor poderá escolher a modalidade de emissão de contingência, ou aguardar a regularização da situação para voltar a emitir a NF-e ABI na modalidade normal.

2.3.2.1. Emissão Normal

O processo de emissão normal é a situação desejada e mais adequada para o emissor, pois é a situação em que todos os recursos necessários para a emissão da NF-e ABI estão operacionais e a autorização de uso da NF-e ABI é concedida normalmente.

Nesta situação, a emissão das NF-e ABI é realizada normalmente, sendo que os respectivos documentos auxiliares somente podem ser gerados após o emitente ter recebido a autorização de uso.

A modalidade alternativa é detalhada no capítulo 6. Contingência.

3. Eventos

Um evento é o registro de uma ocorrência relacionada com um documento fiscal eletrônico.

O evento pode modificar a situação do documento, por exemplo, por cancelamento.

O Sistema de Registro de Eventos da NF-e (SRE) é o modelo genérico que permite o registro da ocorrência por ator que pratica ou recepciona qualquer ocorrência que tenha vinculação ou interesse para a NF-e ABI.

Existe um único Web Service com a funcionalidade de tratar eventos de forma genérica, para facilitar a criação de novos eventos sem a necessidade de criação de novos serviços e com poucas alterações na aplicação de Registro de Eventos do Ambiente Autorizador.

O modelo de mensagem de registro de evento possui o seguinte conjunto mínimo de informações comuns:

  • Identificação do autor do registro;
  • Identificação do evento;
  • Identificação da NF-e ABI vinculada;
  • Informações específicas do evento;
  • Assinatura digital da mensagem.

O leiaute da mensagem de Registro de Evento contém uma parte genérica, comum a todos os tipos de evento, e uma parte específica onde será inserido o XML correspondente a cada tipo de evento em uma tag do tipo any.

O Pacote de Liberação de schemas da NF-e ABI contém o leiaute da parte genérica do Registro de Eventos e um schema para cada leiaute específico dos eventos definidos neste manual.

4. Arquitetura de Comunicação com Emitente

4.1. Modelo Conceitual

As Administrações Tributárias disponibilizam os seguintes serviços:

  • Recepção de NF-e ABI;
  • Consulta da situação atual da NF-e ABI;
  • Consulta do status do serviço;
  • Registro de eventos.

Para cada serviço oferecido existe um Web Service específico. O fluxo de comunicação é sempre iniciado pelo aplicativo do emitente através do envio de uma mensagem ao Web Service com a solicitação do serviço desejado.

O Web Service devolve uma mensagem de resposta confirmando o recebimento da solicitação de serviço ao aplicativo do emitente na mesma conexão.

Arquitetura conceitual de comunicação entre o contribuinte e a Administração Tributária

4.2. Padrões Técnicos

4.2.1. Padrão de Documento XML

4.2.1.1. Padrão de Codificação

A especificação do documento XML adotada é a recomendação W3C para XML 1.0, disponível em www.w3.org/TR/REC-xml, e a codificação dos caracteres é UTF-8; assim, todos os documentos XML devem iniciar com a seguinte declaração:

<?xml version="1.0" encoding="UTF-8"?>

Cada arquivo XML somente poderá ter uma única declaração <?xml version="1.0" encoding="UTF-8"?>. Nas situações em que um documento XML pode conter outros documentos XML, deve-se tomar cuidado para que exista uma única declaração.

4.2.1.2. Declaração namespace

O documento XML deverá ter uma única declaração de namespace no elemento raiz do documento com o seguinte padrão:

xmlns="http://www.portalfiscal.inf.br/nfeabi"

É vedado o uso de declaração namespace diferente do padrão estabelecido.

Para reduzir o tamanho final do arquivo XML da NF-e ABI, alguns cuidados de programação deverão ser assumidos:

  • não incluir zeros não significativos para campos numéricos;
  • não incluir espaços no início ou no final de campos numéricos e alfanuméricos;
  • não incluir comentários no arquivo XML;
  • não incluir anotação e documentação no arquivo XML (TAG annotation e TAG documentation);
  • não incluir caracteres de formatação no arquivo XML (line-feed, carriage return, tab e caractere de espaço entre as TAGs);
  • não incluir prefixo no namespace das tags de NFe.

4.2.1.3. Validação de Schema

Para garantir minimamente a integridade das informações prestadas e a correta formação dos arquivos XML, o emitente deverá, antes de seu envio, submeter o arquivo da NF-e ABI e as demais mensagens XML para validação pelo Schema do XML (XSD - XML Schema Definition), disponibilizado pela Administração Tributária.

4.2.1.4. Tratamento de Caracteres Especiais no Texto de XML

Todos os textos de um documento XML passam por uma análise do parser específico da linguagem. Alguns caracteres afetam o funcionamento deste parser, não podendo aparecer no texto de uma forma não controlada.

Alguns destes caracteres podem aparecer especialmente no campo de Razão Social, Endereço e Informação Adicional. Para resolver esses casos, é recomendável o uso de uma sequência de escape em substituição ao caractere que causa o problema.

Exemplo: a denominação DIAS & DIAS LTDA deve ser informada como DIAS &amp; DIAS LTDA no XML para não afetar o funcionamento do parser.

Nota: a sequência de escape conta como um único caractere para a validação do tamanho do campo pelo Schema.

Tabela 4-1 - Caracteres Especiais no Texto de XML
CaractereDescriçãoSequência de Escape
<sinal de maior&lt;
>sinal de menor&gt;
&e-comercial&amp;
"aspas&quot;
'sinal de apóstrofe&#39;

4.2.2. Padrão de Comunicação

A comunicação será baseada em Web Services disponibilizados pelo Sistema de Recepção de Nota Fiscal Eletrônica.

O meio físico de comunicação utilizado será a Internet, com o uso do protocolo TLS 1.2 ou superior, com autenticação mútua, que, além de garantir um duto de comunicação seguro na Internet, permite a identificação do servidor e do cliente através de certificados digitais, eliminando a necessidade de identificação do usuário através de nome ou código de usuário e senha.

O modelo de comunicação segue o padrão de Web Services definido pelo WS-I Basic Profile.

A troca de mensagens entre os Web Services do ambiente do Sistema de Recepção da NF-e e o aplicativo da empresa será realizada no padrão SOAP versão 1.2, com troca de mensagens XML no padrão Style/Encoding: Document/Literal.

A chamada de diferentes Web Services é realizada com o envio de uma mensagem XML através do parâmetro nfeDadosMsg.

4.2.3. Padrão de Certificado Digital

O certificado digital utilizado no Sistema NF-e ABI será emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira - ICP-Brasil, tipo A1 ou A3, devendo conter o CNPJ da pessoa jurídica titular do certificado digital no campo OtherName OID=2.16.76.1.3.3 ou o CPF da pessoa física titular do certificado digital no campo OtherName OID=2.16.76.1.3.1.

Os certificados digitais serão exigidos em 2 (dois) momentos distintos:

  • Assinatura de Mensagens: o certificado digital utilizado para essa função deverá conter o CNPJ/CPF de um emitente da NF-e ABI.
    • Por mensagens, entenda-se: o Pedido de Autorização de Uso (Arquivo NF-e ABI), o Pedido de Cancelamento de NF-e ABI, o Registro de Evento e demais arquivos XML que necessitem de assinatura.
    • O certificado digital deverá ter o “uso da chave” previsto para a função de assinatura digital, respeitando a Política do Certificado.
  • Transmissão: durante a transmissão das mensagens entre o servidor do emitente e a Administração Tributária, o certificado digital utilizado para identificação do aplicativo do emitente deverá conter o CNPJ/CPF do responsável pela transmissão das mensagens, que não será necessariamente o CNPJ/CPF da empresa emissora da NF-e ABI, devendo ter a extensão Extended Key Usage com permissão de “Autenticação Cliente”.

4.2.4. Padrão de Assinatura Digital

As mensagens enviadas ao Portal da Administração Tributária são documentos eletrônicos elaborados no padrão XML e devem ser assinados digitalmente com um certificado digital que contenha o CNPJ/CPF do emissor da NF-e ABI objeto do pedido.

Alguns elementos estão presentes dentro do Certificado do emitente, tornando desnecessária a sua representação individualizada no arquivo XML. Portanto, o arquivo XML não deve conter os elementos:

<X509SubjectName>
<X509IssuerSerial>
<X509IssuerName>
<X509SerialNumber>
<X509SKI>

Deve-se evitar o uso das TAGs abaixo, pois as informações serão obtidas a partir do Certificado do emitente:

<KeyValue>
<RSAKeyValue>
<Modulus>
<Exponent>

A NF-e ABI utiliza um subconjunto do padrão de assinatura XML definido pelo W3C XML Signature, com o seguinte leiaute:

Schema XML: xmldsig-core-schema_v1.01.xsd

#CampoElePaiTipoOcor.Tam.Descrição/Observação
XS01SignatureRaiz----
XS02SignedInfoGXS01-1-1Grupo da Informação da assinatura
XS03CanonicalizationMethodGXS02-1-1Grupo do Método de Canonicalização
XS04AlgorithmAXS03C1-1Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/REC-xml-c14n-20010315
XS05SignatureMethodGXS02-1-1Grupo do Método de Assinatura
XS06AlgorithmAXS05C1-1Atributo Algorithm de SignatureMethod: http://www.w3.org/2000/09/xmldsig#rsa-sha1
XS07ReferenceGXS02-1-1Grupo Reference
XS08URIAXS07C1-1Atributo URI da tag Reference
XS10TransformsGXS07-1-1Grupo do algorithm de Transform
XS11unique_Transf_AlgRCXS10-1-1Regra para o atributo Algorithm do Transform ser único.
XS12TransformGXS10-2-2Grupo de Transform
XS13AlgorithmAXS12C1-1Atributos válidos Algorithm do Transform: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 e http://www.w3.org/2000/09/xmldsig#enveloped-signature
XS14XPathEXS12C0-NXPath
XS15DigestMethodGXS07-1-1Grupo do Método de DigestMethod
XS16AlgorithmAXS15C1-1Atributo Algorithm de DigestMethod: http://www.w3.org/2000/09/xmldsig#sha1
XS17DigestValueEXS07C1Digest Value (Hash SHA-1 - Base64)
XS18SignatureValueGXS01-1-1Grupo do Signature Value
XS19KeyInfoGXS01-1-1Grupo do KeyInfo
XS20X509DataGXS19-1-1Grupo X509
XS21X509CertificateEXS20C1-1Certificado Digital X509 em Base64

A assinatura do emitente na NF-e ABI será feita na TAG <infNFeABI> identificada pelo atributo Id, cujo conteúdo deverá ser um identificador único (chave de acesso) precedido do literal NFeABI para cada NF-e, conforme leiaute descrito no documento MOC NFe ABI Anexo I Leiaute e RV. O identificador único precedido do literal #NFeABI deverá ser informado no atributo URI da TAG <Reference>. Para as demais mensagens a serem assinadas, o processo é o mesmo, mantendo sempre um identificador único para o atributo Id na TAG a ser assinada.

<NFeABI xmlns="http://www.portalfiscal.inf.br/nfeabi">
  <infNFeABI Id="NFeABI31060243816719000108550000000010001234567897" versao="1.01">
    ...
  </infNFeABI>
  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
      <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
      <Reference URI="#NFeABI31060243816719000108550000000010001234567897">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
          <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
        <DigestValue>vFL68WETQ+mvj1aJAMDx+oVi928=</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>IhXNhbdL1F9UGb2ydVc5v/gTB/y6r0KIFaf5evUi1i ...</SignatureValue>
    <KeyInfo>
      <X509Data>
        <X509Certificate>MIIFazCCBFOgAwIBAgIQaHEfNaxSeOEvZGlVDANB ...</X509Certificate>
      </X509Data>
    </KeyInfo>
  </Signature>
</NFeABI>

Para o processo de assinatura, o emitente não deve fornecer a Lista de Certificados Revogados, já que a mesma será montada e validada no momento da conferência da assinatura digital.

Tabela 4-2 - Padrões de Assinatura Digital
ParâmetroPadrão
Padrão de assinatura“XML Digital Signature”, utilizando o formato “Enveloped” (http://www.w3.org/TR/xmldsig-core/).
Certificado digitalEmitido por AC credenciada no ICP-Brasil (http://www.w3.org/2000/09/xmldsig#X509Data).
Cadeia de CertificaçãoEndCertOnly (incluir na assinatura apenas o certificado do usuário final).
Tipo do certificadoA1 ou A3.
Tamanho da Chave CriptográficaCompatível com os certificados A1 e A3.
Função criptográfica assimétricaRSA (http://www.w3.org/2000/09/xmldsig#rsa-sha1).
Função de “message digest”SHA-1 (http://www.w3.org/2000/09/xmldsig#sha1).
CodificaçãoBase64 (http://www.w3.org/2000/09/xmldsig#base64).
Transformações exigidasÚteis para realizar a canonicalização do XML enviado e a validação correta da Assinatura Digital: Enveloped (http://www.w3.org/2000/09/xmldsig#enveloped-signature) e C14N (http://www.w3.org/TR/2001/REC-xml-c14n-20010315).

4.2.5. Validação de Assinatura Digital pela Administração Tributária

O procedimento para a validação da assinatura digital é:

  1. Extrair a chave pública do certificado;
  2. Verificar o prazo de validade do certificado utilizado;
  3. Montar e validar a cadeia de confiança dos certificados, validando também a LCR (Lista de Certificados Revogados) de cada certificado da cadeia;
  4. Validar o uso da chave utilizada (Assinatura Digital) de tal forma a aceitar certificados somente do tipo A (não serão aceitos certificados do tipo S);
  5. Garantir que o certificado utilizado é de um usuário final e não de uma Autoridade Certificadora;
  6. Adotar as regras definidas pelo RFC 3280 para as LCR e cadeia de confiança;
  7. Validar a integridade de todas as LCR utilizadas pelo sistema;
  8. Verificar o prazo de validade de cada LCR utilizada (data inicial e final).

A forma de conferência da LCR pode ser feita de 2 (duas) maneiras: online ou por download periódico. As assinaturas digitais das mensagens serão verificadas considerando a lista de certificados revogados disponível no momento da conferência da assinatura.

4.2.6. Resumo dos Padrões Técnicos

Tabela 4-3 - Resumo dos Padrões Técnicos
ParâmetroPadrão
Web ServicesPadrão definido pelo WS-I Basic Profile 1.1 (http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html).
Meio lógico de comunicaçãoWeb Services, disponibilizados pela Administração Tributária.
Meio físico de comunicaçãoInternet.
Protocolo InternetTLS versão 1.2, com autenticação mútua através de certificados digitais.
Padrão de troca de mensagensSOAP versão 1.2.
Padrão da mensagemXML no padrão Style/Encoding: Document/Literal.
Padrão de certificado digitalX.509 versão 3, emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira - ICP-Brasil, do tipo A1 ou A3, devendo conter o CNPJ/CPF do proprietário do certificado digital. Para transmissão, utilizar o certificado digital do responsável pela transmissão.
Padrão de assinatura digitalXML Digital Signature, Enveloped, com certificado digital X.509 versão 3, com chave privada de tamanho variável, conforme o padrão da ICP-Brasil (1024, 2048 ou mais bits), com padrões de criptografia assimétrica RSA, algoritmo message digest SHA-1 e utilização das transformações Enveloped e C14N.
Validação de assinatura digitalSerá validada, além da integridade e autoria, a cadeia de confiança com a validação das LCR.
Padrões de preenchimento XMLCampos não obrigatórios do Schema que não possuam conteúdo terão suas tags suprimidas no arquivo XML. Máscaras de números decimais e datas estão definidas no Schema XML. Nos campos numéricos inteiros, não incluir vírgula ou ponto decimal. Nos campos numéricos com casas decimais, utilizar o ponto decimal na separação da parte inteira.

4.2.7. Colunas das Tabelas de Leiaute de Mensagens

Tabela 4-4 - Colunas das Tabelas de Leiaute de Mensagens
Nome da ColunaInformação contida
#Número de referência da tag XML.
CampoNome da tag XML.
EleTipo de elemento: A=Versão; Id=Identificador da TAG a ser assinada; G=Grupo; CG=Grupo exclusivo (Choice Group: somente um dos grupos pode existir); E=Elemento; CE=Elemento exclusivo (Choice Element: somente um dos elementos pode existir).
PaiNúmero de referência da tag XML que contém esta tag XML.
TipoTipo de dado: C=Caractere (alfanumérico); N=Número; D=Data no formato AAAA-MM-DD; DH=Data e hora no formato UTC: AAAA-MM-DDThh:mm:ssTZD, onde AAAA=Ano, MM=Mês, DD=Dia, T=letra “T”, HH=Hora (00 a 23), MM=Minuto, SS=Segundo e TZD=Distância em horas do meridiano de Greenwich.
Ocor.Quantidade de ocorrências: 1-1=elemento obrigatório com no máximo uma ocorrência; 0-1=elemento opcional com no máximo uma ocorrência; 1-n=elemento obrigatório com no máximo “n” ocorrências; 0-n=elemento opcional com no máximo “n” ocorrências.
Tam.Tamanhos aceitos, conforme notação e exemplos da Tabela 4-5.
Descrição/ObservaçãoComentários explicativos desta tag XML.
Tabela 4-5 - Notação e Exemplos de Tamanhos de Elementos em Tabelas de Leiaute XML
Tam.Observação
xTamanho do elemento. Ex.: 5 - o campo deve conter um valor com cinco posições.
x-yTamanho mínimo de “x”, máximo de “y”. Ex.: 0-10 - o campo pode conter nenhum valor (tamanho “0”) até um valor de até dez posições.
xvnCampo de valor, com tamanho de “x” posições na parte inteira, seguido pelo ponto decimal e com “n” casas decimais. Ex.: 11v4 - número com onze posições no inteiro e quatro casas decimais.
xv(n-m)Campo de valor, com tamanho de “x” posições na parte inteira, seguido pelo ponto decimal e com entre “n” e “m” casas decimais. Ex.: 11v(0-6) - número com onze posições no inteiro e zero a seis casas decimais; no caso de zero casas decimais, o ponto decimal não deve ser informado.
(x-y)v(n-m)Campo de valor com tamanho mínimo de “x” e máximo de “y” posições, com entre “n” e “m” casas decimais. Ex.: 1-11v(0-6) - número entre uma e onze posições, com zero a seis casas decimais.
Valores separados por vírgulasO elemento deve ser informado com o tamanho de uma das opções listadas. Ex.: 1, 3, 5, 8 - o campo deve ter um dos quatro tamanhos fixos.

4.3. Modelo Operacional

A solicitação de serviço poderá ser atendida na mesma conexão, ou seja, os serviços são síncronos em função da forma de processamento da solicitação de serviços.

  • Serviços síncronos: o processamento da solicitação de serviço é concluído na mesma conexão, com a devolução de uma mensagem com o resultado do processamento do serviço solicitado.
Tabela 4-6 - Forma de Implementação dos Serviços Web
ServiçoImplementação
Autorização de NF-e ABISíncrona
Consulta da situação atual da NF-e ABISíncrona
Consulta do status do serviçoSíncrona
Registro de eventosSíncrona

Os Web Services disponibilizam os serviços que serão utilizados pelos aplicativos dos emitentes. O mecanismo de utilização dos Web Services segue as seguintes premissas:

  1. É disponibilizado um Web Service por serviço, existindo um método para cada tipo de serviço, com exceção do registro de eventos, que poderá ser atendido por Web Services diferentes conforme o tipo de evento;
  2. Para os serviços síncronos, o envio da solicitação e a obtenção do retorno serão realizados na mesma conexão através de um único método;
  3. As URL dos Web Services encontram-se disponíveis no Portal Nacional da NF-e ABI; mediante acesso à URL pode ser obtido o WSDL (Web Services Description Language) de cada Web Service;
  4. O processo de utilização dos Web Services sempre é iniciado pelo emitente enviando uma mensagem nos padrões XML e SOAP, através do protocolo TLS com autenticação mútua;
  5. A ocorrência de qualquer erro na validação dos dados recebidos interrompe o processo com a disponibilização de uma mensagem contendo o código e a descrição do erro.

4.3.1. Serviços Síncronos

As solicitações de serviços de implementação síncrona são processadas imediatamente e o resultado do processamento é obtido em uma única conexão, conforme o fluxo exposto na Figura 4-2.

Fluxo de um serviço de implementação síncrona

Etapas do processo:

  1. O aplicativo do emitente inicia a conexão enviando uma mensagem de solicitação de serviço para o Web Service;
  2. O Web Service recebe a mensagem de solicitação de serviço e encaminha ao aplicativo da NF-e ABI que irá processar o serviço solicitado;
  3. O aplicativo da NF-e ABI recebe a mensagem de solicitação de serviço e realiza o processamento, devolvendo uma mensagem de resultado do processamento ao Web Service;
  4. O Web Service recebe a mensagem de resultado do processamento e o encaminha ao aplicativo do emitente;
  5. O aplicativo do emitente recebe a mensagem de resultado do processamento e, caso não exista outra mensagem, encerra a conexão.

4.3.2. Número do Protocolo

O número do protocolo (nProt) é gerado pela Administração Tributária para identificar univocamente as transações realizadas de autorização de uso e autorização da NF-e ABI.

Tabela 4-7 - Estrutura do Número do Protocolo
Tipo de AutorizadorCódigo da UFAnoIdentificação do Site AutorizadorSequencial
1 posição2 posições2 posições1 posição10 posições
  • 1 posição para indicar o Tipo Autorizador;
  • 2 posições para o código da UF do IBGE;
  • 2 posições para o ano;
  • 1 posição para o número do Site que autorizou a NF-e ABI (0 para apenas um site);
  • 10 posições para o sequencial no ano.

A geração do número de protocolo é única e é utilizada por todos os Web Services que precisam atribuir um número de protocolo para o resultado do processamento.

4.3.3. Ambientes de Homologação e de Produção

As Administrações Tributárias mantêm dois ambientes para recepção de NF-e ABI. O ambiente de homologação é específico para a realização de testes e integração das aplicações do emitente durante a fase de implementação e adequação do sistema de emissão de NF-e do emitente e nos casos em que este sistema sofre alterações após entrar em regime de operação normal.

A autorização de uso de NF-e ABI no ambiente de produção tem o efeito de permitir que o arquivo da NF-e ABI seja utilizado como documento fiscal.

O acesso a cada um dos ambientes será concedido mediante prévia requisição do emitente ou de ofício, caso seja de interesse da Administração Tributária.

4.4. Padrão de Mensagens dos Web Services

As chamadas dos Web Services disponibilizados pelos Web Services da NF-e ABI e os respectivos resultados do processamento são realizados através das mensagens com o padrão mostrado na Figura 4-3, onde:

  • versaoDados: versão do leiaute da estrutura XML informado na área de dados;
  • Área de Dados: estrutura XML variável definida na documentação do Web Service acessado.
Figura 4-3 - Padrão de Mensagem de Chamada/Retorno de Web Service
versaoDadosElemento nfeCabecMsg (SOAP Header)
Estrutura XML definida na documentação do Web ServiceÁrea de dados (SOAP Body)

4.4.1. Validação da Estrutura XML das Mensagens dos Web Services

As informações são enviadas ou recebidas dos Web Services através de mensagens no padrão XML definido na documentação de cada Web Service.

As alterações de leiaute e da estrutura de dados XML realizadas nas mensagens são controladas através da atribuição de um número de versão para a mensagem.

Um Schema XML é uma linguagem que define o conteúdo do documento XML, descrevendo os seus elementos e a sua organização, além de estabelecer regras de preenchimento de conteúdo e de obrigatoriedade de cada elemento ou grupo de informação.

A validação da estrutura XML da mensagem é realizada por um analisador sintático (parser) que verifica se a mensagem atende às definições e regras de seu Schema XML.

Qualquer divergência da estrutura XML da mensagem em relação ao seu Schema XML provoca um erro de validação do Schema XML.

A primeira condição para que a mensagem seja validada com sucesso é que ela seja submetida com êxito ao Schema XML correspondente.

Assim, os aplicativos do emitente devem estar preparados para gerar as mensagens no leiaute em vigor, devendo ainda informar a versão do leiaute da estrutura XML da mensagem no campo versaoDados da área de cabeçalho da mensagem.

4.4.2. Schemas XML das Mensagens dos Web Services

Toda mudança de leiaute das mensagens dos Web Services implica na atualização do seu respectivo Schema XML.

A maioria dos Schemas XML da NF-e ABI utiliza as definições de tipos básicos ou tipos complexos que estão definidos em outros Schemas XML (ex.: tiposBasico_v1.00.xsd). Nestes casos, a modificação de versão do Schema básico será repercutida no Schema principal.

Por exemplo, o tipo numérico de 15 posições com 2 decimais é definido no Schema tiposBasico_v1.00.xsd. Caso ocorra alguma modificação na definição deste tipo, todos os Schemas que utilizam este tipo básico devem ter a sua versão atualizada e as declarações import ou include devem ser atualizadas com o nome do Schema básico atualizado.

As modificações de leiaute das mensagens dos Web Services podem ser causadas por necessidades técnicas ou em razão da modificação de alguma legislação. As modificações decorrentes de alteração da legislação deverão ser implementadas nos prazos previstos no ato normativo que introduziu a alteração. As modificações de ordem técnica serão divulgadas pela Coordenação Técnica do Sistema e poderão ocorrer sempre que se fizerem necessárias.

4.5. Versão dos Schemas

4.5.1. Controle de Versão

O controle de versão de cada um dos schemas válidos compreende uma definição nacional sobre:

  • qual a versão vigente (versão mais atualizada);
  • quais são as versões anteriores ainda suportadas por todas as SEFAZ.

Este controle de versões permite a adaptação dos sistemas de informática das empresas participantes do Sistema em diferentes datas; desta forma, algumas empresas poderão estar com uma versão de leiaute mais atualizada, enquanto outras empresas poderão ainda estar operando com mensagens em um leiaute anterior.

Não existem mudanças frequentes de leiaute de mensagens e as empresas dispõem de um prazo razoável para implementar as mudanças necessárias, conforme acordo operacional estabelecido. Mensagens recebidas com uma versão de leiaute não suportada serão rejeitadas com uma mensagem de erro específica na versão do leiaute de resposta mais antiga em uso.

5. DANFE-ABI

O DANFE-ABI (Documento Auxiliar da Nota Fiscal Eletrônica) é um documento fiscal auxiliar, que pode ser impresso em papel; sua especificação e modelos de leiaute serão publicados em Nota Técnica.

O DANFE-ABI não é nota fiscal, nem a substitui, servindo apenas como instrumento auxiliar para consulta da NF-e ABI, pois contém a chave de acesso da NF-e ABI, que permite ao detentor desse documento confirmar a efetiva existência de uma NF-e que tenha tido seu uso regularmente autorizado.

O Anexo I define o campo relacionado ao formato de impressão:

IDCampoDescriçãoElePaiTipoOcor.Tam.Observação
B09tpImpFormato de Impressão do DANFEEB01N1-110=Sem geração de DANFE;
1=DANFE-ABI normal, Retrato;
2=DANFE-ABI normal, Paisagem.

6. Contingência

A obtenção da autorização de uso da NF-e ABI é um processo que envolve diversos recursos de infraestrutura, hardware e software. O mau funcionamento ou a indisponibilidade de qualquer um destes recursos pode prejudicar o processo de autorização da NF-e ABI, com reflexos nos negócios do emissor da NF-e ABI, que fica impossibilitado de obter a prévia autorização de uso da NF-e exigida na legislação para a emissão do DANFE-ABI para registro da alienação do bem imóvel.

A alta disponibilidade é uma das premissas básicas do sistema da NF-e ABI. Contudo, existem diversos outros componentes do sistema que podem apresentar falhas e comprometer a disponibilidade dos serviços, exigindo alternativas de emissão da NF-e ABI em contingência.

O Anexo I identifica a modalidade como contingência off-line e prevê o grupo de contingência abaixo:

IDCampoDescriçãoElePaiTipoOcor.Tam.Observação
B14tpEmisTipo de Emissão da NF-e ABIEB01N1-111=Emissão normal (não em contingência);
9=Contingência off-line.
B21gContGrupo de contingênciaGB01-0-1Grupo opcional.
B22dhContData e Hora da entrada em contingênciaEB21D1-1Data e hora no formato UTC: AAAA-MM-DDThh:mm:ssTZD.
B23xJustJustificativa da entrada em contingênciaEB21C1-115-256

7. QR Code

As informações suplementares da NF-e ABI incluem o texto com o QR Code impresso no DANFE-ABI e a URL de consulta por chave de acesso.

IDCampoDescriçãoElePaiTipoOcor.Tam.Observação
ZX01infNFeSuplInformações suplementares da Nota FiscalGRaiz-1-1Informações suplementares da Nota Fiscal, não afetando a assinatura digital.
ZX02qrCodeTexto com o QR-Code impresso no DANFE-ABI.EZX01C1-1100-600
ZX03urlChaveTexto com a URL de consulta por chave de acesso a ser impressa no DANFE-ABIEZX01C1-121-85Informar a URL da “Consulta por chave de acesso da NF-e ABI”.
Preenchimento da URL do QR Code
Versão QR CodeOrientações de Preenchimento da URL do QR Code (id ZX02: qrCode)
1.00Informar a URL da “Consulta da NF-e ABI via QR-Code” no site da SEFAZ, compreendendo:
  • Endereço do site da UF, incluindo o protocolo de comunicação (“http://” ou “https://”);
  • Caractere separador “?”;
  • Parâmetros do QR-Code, concatenados usando o “|” como separador.
Nota 1: respeitar o uso de caracteres maiúsculos/minúsculos.

8. Consulta Pública da NF-e ABI

8.1. Consulta Completa da NF-e ABI

A Consulta Completa, individualmente realizada através da Internet nos portais das Administrações Tributárias, retornará todo o conteúdo da NF-e ABI, exclusivamente aos participantes da operação comercial descritos no documento eletrônico, que desempenham papéis de emitente, destinatário, transportador e terceiros citados no XML da NF-e (informado na tag autXML), por meio do acesso identificado do consulente ao portal da administração tributária.

8.2. Consulta Resumida da NF-e ABI

Para as situações não enquadradas na Consulta Completa, o acesso aos dados da NF-e ABI só será possível através da consulta resumida.