manual web service sisobrapref - receita...

46
Manual Web Service SisobraPref Padrões técnicos de comunicação versão 1.00 1

Upload: others

Post on 02-Aug-2020

14 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

Manual

Web Service SisobraPref

Padrões técnicos de comunicação

versão 1.00

1

Page 2: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

Sumário 1. Introdução 2. Objetivo do Projeto 3. Descrição Simplificada do Modelo Operacional 4. Arquitetura de Comunicação com a Prefeitura

4.1 Modelo Conceitual 4.2 Padrões Técnicos

4.2.1 Padrão de Codificação 4.2.2 Otimização na Montagem do Arquivo 4.2.3 Validação de Schema 4.2.4 Padrão de Comunicação 4.2.5 Padrão de Certificado Digital 4.2.6 Padrão de Assinatura Digital 4.2.7 Resumo dos Padrões Técnicos

4.3 Modelo Operacional 5. Web Service

5.1 Validação da Estrutura XML das Mensagens do Web Service 5.2 Schemas XML das Mensagens dos Web Services 5.3 Versão dos Schemas 5.4 Web Service

5.4.1 RecepcaoLote 5.4.1.1 Leiaute da Mensagem de Entrada 5.4.1.2 Leiaute da Mensagem de Retorno 5.4.1.3 Leiaute Alvará 5.4.1.4 Leiaute Habite­se 5.4.1.5 Leiaute Altera Situação

5.4.2 RecepcaoDeclaracaoSemMovimento 5.4.2.1 Leiaute do Arquivo de Declaração sem Movimento 5.4.2.2 Leiaute do Resultado do Processamento da Declaração de sem Movimento

5.4.3 ConsultaDocumento 5.4.2.1 Leiaute do Arquivo de Consulta Documento 5.4.2.2 Leiaute do Resultado do Processamento da Consulta

5.5 Validação de Regra de Negócio para Certificado Digital de Transmissão 5.6 Validação de Regra de Negócio para Certificado Digital de Assinatura 5.7 Validação de Regra de Negócio para Assinatura 5.8 Final do Processamento 5.9 Número de Protocolo

6.0 Categorias da Obra 7.0 Tabela de Códigos e Descrições de Mensagens 8.0 Tabela de endereços dos web services disponíveis. 9.0 Anexo I

2

Page 3: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

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 serviços da Secretaria da Receita Federal do Brasil (RFB) e os sistemas de informações das prefeituras que possuem sistema próprio de controle de alvará, habite­se e declaração de sem movimento.

2. Objetivo do Projeto Tem por objetivo o cadastramento de dados de alvarás e/ou habite­se de obras de construção civil para a transmissão dessas informações à base da RFB. Até meados de 1997, as prefeituras municipais devido à existência de dispositivo na Lei n° 8.212, de 24 de julho de 1991, eram obrigadas a exigir dos responsáveis pela execução de obras de construção civil, a comprovação da matrícula da obra no Instituto Nacional do Seguro Social (INSS) para a emissão de alvarás, bem como de certidão de regularização para a emissão de habite­se. A partir de então, em virtude de mudança na referida Lei, acabou­se essa obrigatoriedade, substituindo­se pela exigência de informar mensalmente a relação de alvarás e habite­se emitidos no mês anterior. Como, resolveu­se uniformizar e atualizar a forma de os órgãos públicos transmitirem essas informações à RFB, por força do art. 2° da Lei n° 11.457, de 16 de março de 2007, se faz necessário desenvolver novo sistema que propicie essa uniformização e controle das informações dos documentos, sistema adequado ao Programa de Unificação do Crédito Fazendário e Previdenciário e com o objetivo, também, de aumentar a quantidade de inscrições de obras, principalmente daqueles de responsabilidade de pessoas físicais.

3. Descrição Simplificada do Modelo Operacional A prefeitura emissora de alvará, habite­se e declaração de sem movimento gera um arquivo eletrônico contendo as informações da obra, o qual deverá ser assinado digitalmente, transformando esse arquivo em um documento eletrônico de maneira a garantir a integridade dos dados e a autoria do emissor. Esse arquivo eletrônico será transmitido pela Internet para a RFB, a qual, após verificar a integridade formal e regras de negócio, devolverá um número de protocolo para cada documento enviado no lote. Para utilizar esse serviço da RFB a prefeitura deverá ser optante pelo Domicílio Tributário Eletrônico (DTE).

4. Arquitetura de Comunicação com a Prefeitura

3

Page 4: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

4.1 Modelo Conceitual A RFB irá disponibilizar os seguintes serviços:

1) Recepção de alvará e habite­se:

Recepção de lotes contendo alvará e habite­se ou alteração de situação de alvará e habite­se. A alteração de situação envolve o cancelamento ou reativação de um determinado alvará e/ou habite­se. 2) Recepção de declaração de sem movimento.

Recepção de lotes de declaração de sem movimento. 3) Consulta de alvará e habite­se.

Consulta individual de alvará e habite­se.

Existirá um Web Service contendo esses serviços. O fluxo de comunicação é sempre iniciado pelo aplicativo da prefeitura através do envio de uma mensagem ao Web Service com a solicitação do serviço desejado. Toda prefeitura que utilizar a solução Web Service deverá obrigatoriamente estar habilitada no Domicílio Tributário Eletrônico (DTE).

4.2 Padrões Técnicos

4.2.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 será em UTF­8, assim todos os documentos XML serão iniciados 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"?>.

4.2.2 Otimização na Montagem do Arquivo Para reduzir o tamanho final do arquivo XML 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);

4

Page 5: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

não incluir caracteres de formatação no arquivo XML ("line­feed", "carriage return", "tab", caractere de "espaço" entre as TAGs).

4.2.3 Validação de Schema Para garantir minimamente a integridade das informações prestadas e a correta formação dos arquivos XML, a prefeitura deverá submeter o arquivo XML para validação pelo Schema do XML (XSD – XML Schema Definition), disponibilizado pela RFB.

4.2.4 Padrão de Comunicação A comunicação será baseada em Web Services disponibilizados pela RFB. O meio físico de comunicação utilizado será a Internet, com o uso do protocolo SSL versão 3.0, 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. A troca de mensagens entre o Web Services e o aplicativo da prefeitura será realizada no padrão SOAP versão 1.2 e WSDL 1.2.

4.2.5 Padrão de Certificado Digital O certificado digital utilizado no SisobraPref será emitido por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira – ICP­Brasil, tipo A1 ou A3, devendo conter o número de Cadastro Nacional de Pessoa Jurídica (CNPJ) da pessoa jurídica titular do certificado digital.

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

a) Assinatura do aquivo XML: O certificado digital utilizado para essa função deverá

conter o CNPJ da prefeitura. O certificado digital deverá ter o “uso da chave” previsto para a função de assinatura digital, respeitando a Política do Certificado.

b) Transmissão (durante a transmissão das mensagens entre o servidor da prefeitura e

a RFB): O certificado digital utilizado para identificação do aplicativo da prefeitura deverá conter o CNPJ do responsável pela transmissão das mensagens, devendo ter a extensão Extended Key Usage com permissão de "Autenticação Cliente".

4.2.6 Padrão de Assinatura Digital

5

Page 6: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

As mensagens enviadas à RFB são documentos eletrônicos elaborados no padrão XML e devem ser assinados digitalmente com um certificado digital que contenha o CNPJ prefeitura emissora do alvará, habite­se ou declaração de sem movimento. O SisobraPref utiliza um subconjunto do padrão de assinatura XML definido pelo http://www.w3.org/TR/xmldsig­core/, com o seguinte leiaute: Schema XML: xmldsig­core­schema_v1.01.xsd Observação Legenda para a coluna Ele: A ­ indica que o campo é um atributo do Elemento anterior; E ­ indica que o campo é um Elemento; CE – indica que o campo é um Elemento que deriva de uma Escolha (Choice); G – indica que o campo é um Elemento de Grupo; CG ­ indica que o campo é um Elemento de Grupo que deriva de uma Escolha (Choice); RC – indica que o campo é uma key constraint (Restrição de Chave) para garantir a unicidade e presença do valor;

# Campo Ele. Pai Ocor Descrição / Observação

X1 Signature Raiz ­ ­

X2 SignedInfo G X1 1­1

X3 CanonicalizationMethod

G X2 1­1 Grupo do Método de Canonicalização

X4 Algorithm A X3 1­1 Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/REC­xml­c14n­20010315

X5 SignatureMethod G X2 1­1 Grupo do Método de Assinatura

X6 Algorithm A X5 1­1 Atributo Algorithm de SignatureMethod: http://www.w3.org/2000/09/xmldsig#rsa­sha1

X7 Reference G X2 1­1 Grupo Reference

X8 URI A X7 1­1 Atributo URI da tag Reference

X9 Transforms G X7 1­1 Grupo do algorithm de Transform

6

Page 7: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

X10 unique_Transf_Alg RC X9 1­1 Regra para o atributo Algorithm do Transform ser único.

X11 Transform G X9 2­2 Grupo de Transform

X12 Algorithm A X11

1­1 Atributos válidos Algorithm do Transform: http://www.w3.org/TR/2001/REC­xml­c14n­20010315 http://www.w3.org/2000/09/xmldsig#enveloped­signature

X13 XPath E X11

0­N XPath

X14 DigestMethod G X7 1­1 Grupo do Método de DigestMethod

X15 Algorithm A X14

1­1 Atributo Algorithm de DigestMethod: http://www.w3.org/2000/09/xmldsig#sha1

X16 DigestValue E X7 1­1 Digest Value (Hash SHA­1 – Base64)

X17 SignatureValue G X1 1­1 Grupo do Signature Value

X18 KeyInfo G X1 1­1 Grupo do KeyInfo

X19 X509Data G X18

1­1 Grupo X509

X20 X509Certificate E X19

1­1 Certificado Digital X509 em Base64

A assinatura dos documentos será conforme tabela abaixo.

Documento Assinar TAG

Alvará infAlvara

Habite­se infHabitese

Declaração de sem movimento infDsm

Para o processo de assinatura a prefeitura não deve fornecer a Lista de Certificados Revogados, já que a mesma será montada e validada pela RFB no momento da conferência da assinatura digital. A assinatura digital do documento eletrônico deverá atender aos seguintes padrões adotados:

a) Padrão de assinatura: “XML Digital Signature”, utilizando o formato “Enveloped”

7

Page 8: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

(http://www.w3.org/TR/xmldsig­core/); b) Certificado digital: Emitido por AC credenciada no ICP­Brasil

(http://www.w3.org/2000/09/xmldsig#X509Data); c) Cadeia de Certificação: EndCertOnly (incluir na assinatura apenas o certificado do

usuário final); d) Tipo do certificado: A1 ou A3; e) Tamanho da Chave Criptográfica: compatível com os certificados A1 e A3 (1024

bits); f) Função criptográfica assimétrica: RSA

(http://www.w3.org/2000/09/xmldsig#rsa­sha1); g) Função de “message digest”: SHA­1 (http://www.w3.org/2000/09/xmldsig#sha1); h) Codificação: Base64 (http://www.w3.org/2000/09/xmldsig#base64); i) Transformações exigidas: útil para realizar a canonicalização do XML enviado para

realizar a validação correta da Assinatura Digital. São elas: 1) Enveloped (http://www.w3.org/2000/09/xmldsig#enveloped­signature) 2) C14N (http://www.w3.org/TR/2001/REC­xml­c14n­20010315)

4.2.7 Resumo dos Padrões Técnicos A tabela a seguir resume os principais padrões de tecnologia utilizados:

Característica Descrição

Meio lógico de comunicação Web Services disponibilizado pela RFB.

Meio físico de comunicação Internet

Protocolo Internet SSL versão 3.0, com autenticação mútua através de certificados digitais.

Padrão da mensagem XML no padrão Style/Encoding: Document/Literal.

Padrão de certificado digital X.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 da prefeitura. Para transmissão, utilizar o certificado digital para transmissão.

Padrão de assinatura digital XML 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.

8

Page 9: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

Validação de assinatura digital

Será validada, além da integridade e autoria, a cadeia de confiança com a validação das LCR.

Padrões de preenchimento XML

­ Campos não obrigatórios do Schema que não possuam conteúdo terão suas tags suprimidas no arquivo XML. ­ Máscara de números decimais e datas estão definidas no Schema XML. ­ Nos campos numéricos inteiro, não incluir a vírgula ou ponto decimal. ­ Nos campos numéricos com casas decimais, utilizar o “ponto decimal” na separação da parte inteira.

4.3 Modelo Operacional A forma de processamento no sistema SisobraPref será síncrona, isto é, o resultado do processamento é obtido na mesma conexão. Etapas do processo:

1. O aplicativo da prefeitura 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 que irá processar o serviço solicitado;

3. Realiza o processamento, devolvendo uma mensagem de resultado do processamento do aplicativo da prefeitura;

4. O aplicativo da prefeitura recebe a mensagem de resultado do processamento e encerra a conexão.

5. Web Service O Web Service disponibiliza os serviços que serão utilizados pelo aplicativo da prefeitura. O mecanismo de utilização do Web Service segue as seguintes premissas: a) Será disponibilizado um Web Service com um método para cada tipo de serviço. Temos três tipos de serviços:

­ envio de lote de alvará e habite­se; ­ envio de lote de declaração de sem movimento; ­ consulta documento (alvará e habite­se).

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

9

Page 10: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

c) O processo de utilização do Web Service sempre é iniciado pela prefeitura enviando uma mensagem nos padrões XML e SOAP, através do protocolo SSL com autenticação mútua. d) 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. Existirá um Web Service Recepcao contendo três web métodos:

recepcaoLote: recepção de alvará e habite­se recepcaoDSM: recepção de declaração de sem movimento consultarDocumento: consulta alvará e habite­se

A mensagem será descartada se o tamanho exceder o limite previsto de 500 KB. A aplicação da prefeitura não poderá permitir a geração de mensagem com tamanho superior a 500 KB. Caso isto ocorra, teremos a devolução da mensagem de rejeição ER201.

5.1 Validação da Estrutura XML das Mensagens do Web Service As informações são enviadas ou recebidas do Web Service através de mensagens no padrão XML definido na documentação. 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 as 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 ao Schema XML correto. Assim, os aplicativos da prefeitura devem estar preparados para gerar as mensagens no leiaute em vigor.

5.2 Schemas XML das Mensagens dos Web Services Toda mudança de leiaute das mensagens do Web Service implica a atualização do seu respectivo Schema XML. A identificação da versão dos Schemas será realizada com o acréscimo do número da versão no nome do arquivo precedida do literal “_v‟, como segue:

­ LoteAlvaraHabitese_v100.xsd (Schema XML na versão 1.00)

10

Page 11: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

5.3 Versão dos Schemas A cada nova versão será disponibilizado um arquivo compactado contendo o conjunto de schemas a serem utilizados pelas prefeituras para a geração dos arquivos XML. Este arquivo será denominado “SisobraPref” e será numerado sequencialmente. Exemplificando: O arquivo SisobraPref_001.zip representa o conjunto de schemas nº 1.

5.4 Web Service

5.4.1 RecepcaoLote Função: serviço destinado a recepção de lotes de alvará e habite­se Método: recepcaoLote

5.4.1.1 Leiaute da Mensagem de Entrada Entrada: Estrutura XML com alvarás e habite­se. Schema XML: LoteAlvaraHabitese_v100.xsd

# Campo Ele. Pai Ocor Descrição / Observação

A1 sisobraPref Raiz ­ ­ TAG raiz

A2 versao A A1 1­1 Versão do lote

A3 Alvara E A1 0­50 Conjunto de Alvarás. Ver Leiaute Alvará. O schema XML obriga ter pelo menos 1 documento (alvará ou habite­se)

A4 Habitese E A1 0­50 Conjunto de Habite­se. Ver Leiaute Habite­se. O schema XML obriga ter pelo menos 1 documento (alvará ou habite­se)

A5 AlteraSituacao E A1 0­10 Cancelar ou reativar alvará ou habite­se. Ver Leiaute Altera Situação No schema XML é opcional esta tag.

5.4.1.2 Leiaute da Mensagem de Retorno Retorno: Estrutura XML com a mensagem do resultado do processamento. Schema XML: retornoLoteAlvaraHabitese_v100.xsd

11

Page 12: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

# Campo Ele. Pai Ocor Descrição / Observação

1 retSisobraPref Raiz ­ ­

1.1 versao A 1 1­1 Atributo versão do leiaute da resultado do processamento do lote de alvará e habite­se

2 Alvara G 1 0­50

2.1 codRetorno E 2 1­1 Código de retorno do resultado do processamento

2.2 descricao E 2 1­1 Descrição do resultado do processamento

2.3 protocolo E 2 0­1 Número de protocolo de processamento do documento

2.4 numeroAlvara E 2 1­1 Número do alvará autorizado

3 Habitese G 1 0­50

3.1 codRetorno E 3 1­1 Código de retorno do resultado do processamento

3.2 descricao E 3 1­1 Descrição do resultado do processamento

3.3 protocolo E 3 0­1 Número de protocolo de processamento do documento

3.4 numeroHabitese E 3 1­1 Número do habitese autorizado

4 AlteraSituacao G 1 0­1

4.1 codRetorno E 4 1­1 Código de retorno do resultado do processamento

4.2 descricao E 4 1­1 Descrição do resultado do processamento

4.3 protocolo E 4 1­1 Número de protocolo de processamento

5 Notificacao G 1 0­1

5.1 codigoNotificacao E 5 1­1 Código da notificação

5.2 ano E 5 1­1 Ano de exercício

5.3 mes E 5 1­1 Mês atual

12

Page 13: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

5.4. dataPrazoFinal E 5 1­1 Prazo final da entrega. Até o décimo dia do mês subsequente.

5.5 dataEntrega E 5 1­1 Data da entrega do documento.

5.6 dataVencimento E 5 1­1 Data de vencimento da multa.

5.7 valorNotificacao E 5 1­1 Valor da multa.

6.1 codRetorno E 1 0­1 Código de retorno do resultado do processamento do lote

6.2 descricao E 1 0­1 Descrição do resultado do processamento do lote

5.4.1.3 Leiaute Alvará Schema XML: LeiauteAlvara_v100.xsd

# Campo Ele. Pai Ocor

Msg

Descrição / Observação

1 infAlvara G A3 1­1 ­

1.1 Id A 1 1­1 ER042 ER240

Atributo com o número do alvará. Regra: o número do alvará não poderá repetir no período do ano para uma mesma prefeitura.

2 numeroProtocoloAnterior

E 1 0­1 ER202 ER203

Número do protocolo anterior. O preenchimento será obrigatório na retificação de alvará.

3 nomeObra E 1 1­1 ­ Nome da obra

4 dataAlvara E 1 1­1 ER221 ER239

Data do alvará. Formato: AAAA­MM­DD

5 dataInicioObra E 1 1­1 Data início da obra. Formato: AAAA­MM­DD

6 dataFinalObra E 1 0­1 ER008

Data final da obra. Formato: AAAA­MM­DD

13

Page 14: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

7 tipoAlvara E 1 1­1 ER057 ER058 ER059 ER060

Tipo do Alvará: ­ inicial ­ retificado

8 responsavelExecObra

E 1 1­1 Responsável pela Execução da Obra:

­ proprietario_do_imovel ­ dono_da_obra ­ incorporador_construcao_civil ­ empresa_construtora ­ empresa_lider_consorcio ­ consorcio ­ construcao_nome_coletivo

8.1 proprietario_do_imovel

CE 8 0­1

8.2 dono_da_obra CE 8 0­1 Pode ser pessoa física ou jurídica e é aquele que é responsável pela execução da obra sem ser o proprietário do imóvel.

8.2.1 cnpj CE 8.2 0­1 ER003 ER214 ER223

8.2.2 cpf CE 8.2 0­1 ER003 ER213 ER222

8.3 incorporador_construcao_civil

CE 8 0­1 Pode ser pessoa física ou jurídica e é aquele que exerce a atividade com o intuito de promover e realizar a construção de

14

Page 15: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

edificações, composta de unidades autônomas, para a alienação parcial ou total.

8.3.1 cnpj CE 8.3 0­1 ER003 ER214 ER223

8.3.2 cpf CE 8.3 0­1 ER003 ER213 ER222

8.4 empresa_construtora

CE 8 0­1 Apenas pessoa jurídica. Aquela que executa a obra e possui registro no CREA.

8.4.1 cnpj E 8.4 1­1 ER061 ER003 ER214 ER223

8.5 empresa_lider_consorcio

CE 8 0­1 Mais de uma pessoa jurídica e a líder é aquela que concentra as informações pela execução da obra pelo consórcio.

8.5.1 cnpjConsorcio E 8.5 1­1 ER003 ER214 ER223

8.5.2 cnpjEmpresaLiderConsorcio

E 8.5 1­1 ER064 ER003

15

Page 16: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

ER214 ER223

8.6 consorcio CE 8 0­1 Mais de uma pessoa jurídica e a líder é aquela que concentra as informações pela execução da obra pelo consórcio.

8.6.1 cnpjConsorcio E 8.6 1­1 ER003 ER214 ER223

8.6.2 cnpjEmpresaLiderConsorcio

E 8.6 1­1 ER064 ER003 ER214 ER223

8.7 construcao_nome_coletivo

CE 8 0­1 ER062 ER0

Mais de uma pessoa jurídica e/ou física. Obra de construção civil realizada por conjunto de pessoas físicas e/ou jurídicas, sem a convenção de condomínio nem memorial de incorporação arquivados no cartório de registro de imóveis.

8.7.1 cpfResponsavelPrincipal

CE 8.7 1­1 ER003 ER213 ER222

8.7.2 cnpjResponsavelPrincipal

CE 8.7 1­1 ER003 ER214 ER2

16

Page 17: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

23

8.7.3 cnpj E 8.7 0­10 ER003 ER212 ER223

8.7.4 cpf E 8.7 0­10 ER003 ER212 ER222

9 enderecoObra G 1 1­1 Informação sobre endereço da obra

9.1 cep E 9 1­1 ER236 ER035 ER036 ER229

CEP da obra deve ser do mesmo município da prefeitura.

9.2 tipoLogradouro E 9 0­1 ER004

Tipo do logradouro. Campo obrigatório apenas para obras com unidade de medida m².

9.3 logradouro E 9 0­1 ER004

Logradouro Campo obrigatório apenas para obras com unidade de medida m².

9.4 numero E 9 0­1 ER004

Número do endereço da obra Campo obrigatório apenas para obras com unidade de medida m².

9.5 complemento E 9 0­1 Complemento do endereço da obra

9.6 bairro E 9 0­1 ER004

Bairro da obra Campo obrigatório apenas para obras com unidade de medida m².

10 unidadeMedida E 1 1­1 Unidade de medida da obra

17

Page 18: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

­ M2 ­ M3 ­ KM ­ KW ­ KVA ­ Outros

11 valorUnidadeMedida

CE 1 0­1 ER004

Valor da unidade de medida. Apenas para unidade de medida diferente de m².

12 area CG 1 0­1 ER230 ER276

12.1 areaPrincipal CG 12 0­99

12.1.1

categoria E 12.1 1­1 ER232 ER276

As opções de categoria: ­ obra_nova ­ acrescimo ­ reforma ­ demolicao ­ existente Ver regra 5.4.7 Categorias da obra

12.1.2

destinacao E 12.1 1­1 ER276

As opções de destinação: ­ residencial_unifamiliar ­ residencial_multifamiliar ­ comercial_salas_lojas ­ edificio_garagens ­ galpao_industrial ­ casa_popular ­ conjunto_habitacional_popular.

12.1.3

tipoObra E 12.1 1­1 As opções de tipo de obra: ­ alvenaria ­ madeira ­ mista

12.1.4

qtd_total_unidades_bloco

E 12.1 0­1 ER218 ER220 ER2

Campo disponível apenas quando uma das destinações da área principal for "Conjunto Habitacional Popular".

18

Page 19: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

53

12.1.5

area E 12.1 1­1 ER029 ER039 ER065

Valor da metragem (metro quadrado ­ m²) da área

12.2 areaComplementar

CG 12 0­99 ER230

12.2.1

categoria E 12.2 1­1 ER232 ER276

As opções de categoria: ­ obra_nova ­ acrescimo ­ reforma ­ demolição ­ existente Ver regra 5.4.7 Categorias da obra

12.2.2

destinacao E 12.2 1­1 ER276

As opções de destinação: ­ residencial_unifamiliar ­ residencial_multifamiliar ­ comercial_salas_lojas ­ edificio_Garagens ­ galpão_industrial ­ casa_popular ­ conjunto_habitacional_popular.

12.2.3

tipoObra E 12.2 1­1 As opções de tipo de obra: ­ alvenaria ­ madeira ­ mista

12.2.4

tipoAreaComplementar

E 12.2 1­1 As opções de tipo da área: ­ quadra ­ estacionamento_terreo ­ piscina ­ area_posto_gasolina

12.2.5

qtd_total_unidades_bloco

E 12.2 0­1 ER218 ER220

Campo disponível apenas quando uma das destinações da área principal for "Conjunto Habitacional Popular".

19

Page 20: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

12.2.6

areaCoberta E 12.2 1­1 ER029 ER065

Valor da metragem (metro quadrado ­ m²) da área coberta

12.2.7

areaDescoberta E 12.2 1­1 ER029 ER065

Valor da metragem (metro quadrado ­ m²) da área descoberta

14 proprietarioObra G 1 1­1

14.1 cpf CE 13 0­1 ER003 ER213 ER222

14.2 cnpj CE 13 0­1 ER003 ER214 ER223

15 infoAdicionais G 1 0­1

15.1 situacao E 14 0­1 Permite informações adicionais sobre a obra.

15.2 classe E 14 0­1 Classes do Alvará da obra

15.3 numeroProcesso E 14 0­1 Número do processo do Alvará da obra

15.4 responsavelTecnico

E 14 0­1

15.4.1

engenheiro CG 14.1 0­1

15.4.1.1

nome E 14.1.1

1­1 Nome do engenheiro habilitado responsável pela execução da obra.

15.4.1.2

crea E 14.1.1

1­1 Número no Conselho Regional de

20

Page 21: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

Engenharia

15.4.1.3

art E 14.1.1

1­1 Número do documento expedido pelo CREA(ART)

15.4.2

arquiteto CG 14.1 0­1

15.4.2.1

nome E 14.2.1

1­1 Nome do arquiteto habilitado responsável pela execução da obra.

15.4.2.2

cau E 14.2.1

1­1 Número no Conselho Regional de Arquitetura

15.4.2.3

rrt E 14.2.1

1­1 Número do documento expedido pelo CAU(RRT)

15.5 responsavelProjeto

G 14 0­1

15.5.1

engenheiro CG 14.1 0­1

15.5.1.1

nome E 14.1.1

1­1 Nome do engenheiro habilitado responsável pela execução da obra.

15.5.1.2

crea E 14.1.1

1­1 Número no Conselho Regional de Engenharia

15.5.1.3

art E 14.1.1

1­1 Número do documento expedido pelo CREA(ART)

15.5.2

arquiteto CG 14.1 0­1

15.5.2.1

nome E 14.2.1

1­1 Nome do arquiteto habilitado responsável pela execução da obra.

15.5.2.2

cau E 14.2.1

1­1 Número no Conselho Regional de Arquitetura

15.5.2.3

rrt E 14.2.1

1­1 Número do documento expedido pelo CAU(RRT)

21

Page 22: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

15.6 especificacao E 14 0­1 Detalhadamente no que consiste a obra

15.7 obs E 14 0­1 Observações e outras informações sobre a obra.

5.4.1.4 Leiaute Habite‐se Schema XML: LeiauteHabitese_v100.xsd

# Campo Ele. Pai Ocor

Msg

Descrição / Observação

1 infHabitese G ­ 1­1

1.1 Id A 1 1­1 ER047 ER203 ER255 ER048 ER070

Atributo com o número do habite­se Regra: o número do habite­se ATIVO não poderá repetir no período do ano para uma mesma prefeitura.

2 dataHabitese E 1 1­1 ER221 ER066 ER005

Data do habite­se. Formato: AAAA­MM­DD

3 dataInicioObra E 1 1­1 Data início da obra. Formato: AAAA­MM­DD

4 dataFinalObra E 1 0­1 ER008

Data final da obra. Formato: AAAA­MM­DD

5 tipoHabitese E 1 1­1 Tipo do habite­se: ­ Total ­ Parcial

6 observacao E 1 0­1

8 unidadeMedida E 1 1­1 ER2 Unidade de medida da obra

22

Page 23: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

56 ­ M2 ­ M3 ­ KM ­ KW ­ KWA ­ Outros

9 valorUnidadeMedida

CE 1 0­1 ER050 ER004 ER054

Valor da unidade de medida. Apenas para unidade de medida diferente de m².

10 area CG 1 0­1 ER053 ER244

10.1 areaPrincipal CG 10 0­99 ER230

10.1.1

categoria E 10.1 1­1 ER232

As opções de categoria: ­ obra_nova ­ acrescimo ­ reforma ­ demolição ­ existente Ver regra 5.4.7 Categorias da obra

10.1.2

destinacao E 10.1 1­1 ER220

As opções de destinação: ­ residencial_Unifamiliar ­ residencial_multifamiliar ­ comercial_salas_lojas ­ edifício_garagens ­ galpão_industrial ­ casa_popular ­ conjunto_habitacional_popular.

10.1.3

tipoObra E 10.1 1­1 As opções de tipo de obra: ­ Alvenaria ­ Madeira ­ Mista

23

Page 24: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

10.1.4

qtd_total_unidades_bloco

E 10.1 0­1 ER218 ER220 ER253

Campo disponível apenas quando uma das destinações da área principal for "Conjunto Habitacional Popular".

10.1.5

area E 10.1 1­1 ER029 ER039 ER049 ER065

Valor da metragem (metro quadrado ­ m²) da área

10.2 areaComplementar

CG 10 0­99 ER230

10.2.1

categoria E 10.2 1­1 ER232

As opções de categoria: ­ obra_nova ­ acrescimo ­ reforma ­ demolição ­ existente Ver regra 5.4.7 Categorias da obra

10.2.2

destinacao E 10.2 1­1 ER220

As opções de destinação: ­ residencial_Unifamiliar ­ residencial_multifamiliar ­ comercial_salas_lojas ­ edifício_garagens ­ galpão_industrial ­ casa_popular ­ conjunto_habitacional_popular.

10.2.3

tipoObra E 10.2 1­1 As opções de tipo de obra: ­ Alvenaria ­ Madeira ­ Mista

10.2.4

tipoAreaComplementar

E 10.2 1­1 As opções de tipo da área: ­ quadra ­ estacionamento_terreo

24

Page 25: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

­ piscina ­ area_posto_gasolina

10.2.5

qtd_total_unidades_bloco

E 10.2 0­1 ER218 ER220

Campo disponível apenas quando uma das destinações da área principal for "Conjunto Habitacional Popular".

10.2.6

areaCoberta E 10.2 1­1 ER029 ER049 ER065

Valor da metragem (metro quadrado ­ m²) da área coberta

10.2.7

areaDescoberta E 10.2 1­1 ER029 ER049 ER065

Valor da metragem (metro quadrado ­ m²) da área descoberta

11 numeroAlvara E 1 1­1 ER203

Número do alvará vinculado ao habite­se.

12 dataAlvara E 1 1­1 ER203

Data do alvará. Formato: AAAA­MM­DD

5.4.1.5 Leiaute Altera Situação Schema XML: LeiauteAlteraSituacao_v100.xsd Objetivo: realizar a operação de cancelar e reativar alvará e/ou habite­se

# Campo Ele. Pai Ocor

Msg

Descrição / Observação

1 infDocumento G A5 1­1 ­

1.1 Id A 1 1­1 ER266

Atributo com o número do documento

1.2 tipoDocumento E 1 1­1 Indica o tipo do documento ­ Alvará ­ Habite­se

25

Page 26: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

1.3 situacao E 1 1­1 ER215 ER216 ER254

Indica a situação ­ Cancelado ­ Reativado

1.4 numeroProtocolo E 1 1­1 ER266

Número do protocolo do documento que deseja cancelar ou reativar

1.5 ano E 1 1­1 ER266

Ano da data da emissão do documento.

1.6 mes E 1 1­1 ER266

Mês da data da emissão do documento

5.4.2 RecepcaoDeclaracaoSemMovimento Função: serviço destinado à recepção de declaração de sem movimento Método: recepcaoDSM

5.4.2.1 Leiaute do Arquivo de Declaração sem Movimento Entrada: Estrutura XML com declaração de sem movimento. Schema XML: DSM_v100.xsd

# Campo Ele. Pai Ocor

Msg

Descrição / Observação

1 sisobraPref Raiz ­ ­ ­

1.1 versao A 1 1­1 ­ Versão do DSM

2 dsm G 1 1­1 ­

3 infDsm G 2 1­1 ­

3.1 Id A 3 1­1 ­ Atributo com o campo ano e mês. Formato: AAAAMM AAAA: ano MM: mês

4 ano E 3 1­1 ER003 ER2

Ano sem movimento

26

Page 27: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

75

5 mes E 3 1­1 ER003 ER275

Mês sem movimento

5.4.2.2 Leiaute do Resultado do Processamento da Declaração de sem Movimento Retorno: Estrutura XML com a mensagem do resultado. Schema XML: retornoDSM_v100.xsd

# Campo Ele. Pai Ocor Descrição / Observação

1 retSisobraPref Raiz ­ ­

1.1 versao A 1 1­1 Atributo versão do leiaute do resultado do processamento da declaração de sem movimento

2 dsm G 1 1­1

2.1 codRetorno E 2 1­1 Código de retorno do resultado do processamento

2.2 descricao E 2 1­1 Descrição do resultado do processamento

2.3 protocolo E 2 0­1 Número de protocolo de processamento do documento.

2.4 ano E 2 0­1 Ano sem movimento

2.5 mes E 2 0­1 Mês sem movimento

3 Notificacao G 1 0­1

3.1 codigoNotificacao E 3 1­1 Código da notificação

3.2 ano E 3 1­1 Ano de exercício

3.3 mes E 3 1­1 Mês atual

3.4. dataPrazoFinal E 3 1­1 Prazo final da entrega. Até o décimo dia do mês subsequente.

3.5 dataEntrega E 3 1­1 Data da entrega do documento.

27

Page 28: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

3.6 dataVencimento E 3 1­1 Data de vencimento da multa.

3.7 valorNotificacao E 3 1­1 Valor da multa.

5.4.3 ConsultaDocumento Função: serviço destinado à consulta de alvará e habite­se Método: consultarDocumento

5.4.2.1 Leiaute do Arquivo de Consulta Documento Entrada: Estrutura XML de consulta de documento. Schema XML: LeiauteConsultaDocumento_v100.xsd

# Campo Ele. Pai Ocor

Msg

Descrição / Observação

1 ConsultaDocumento Raiz ­ ­ ­

1.1 versao A 1 1­1 ­ Versão do arquivo.

2 documento E 1 1­1 ­ Determina qual documento será consultado: alvará ou habite­se

3 numeroDocumento E 1 1­1 ER203 ER204

Número do documento

4 ano E 1 1­1 ER203 ER204

Ano do documento

5.4.2.2 Leiaute do Resultado do Processamento da Consulta Retorno: Estrutura XML com a mensagem do resultado. Schema XML: retornoConsultaDocumento_v100.xsd

# Campo Ele. Pai Ocor Descrição / Observação

1 retConsultaDocumento Raiz ­ ­

28

Page 29: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

1.1 versao A 1 1­1 Versão do arquivo.

2 Alvara CE 1 0­1 XML do alvará

3 Habitese CE 1 0­1 XML do habite­se

4 codRetorno E 1 0­1 Código de retorno do resultado do processamento em caso de falha.

5 descricao E 1 0­1 Descrição do resultado do processamento em caso de falha.

5.5 Validação de Regra de Negócio para Certificado Digital de Transmissão

# Regra de Validação Msg

C1 Certificado de Transmissor Inválido: ­ Certificado de Transmissor inexistente na mensagem

ER300

C2 Validade do Certificado (data início e data fim) ER301

C3 Falta a extensão de CNPJ no Certificado (OtherName ­ OID=2.16.76.1.3.3) ER302

C4 LCR do Certificado de Transmissor ­ Falta o endereço da LCR (CRL DistributionPoint) ­ LCR indisponível ­ LCR inválida

ER303

C5 Certificado do Transmissor revogado ER304

C6 Certificado Raiz difere da "ICP­Brasil" ER305

C7 CNPJ não pertence a uma prefeitura ER074

C8 Certificado Transmissor ­ CNPJ não é optante pelo Domicílio Tributário Eletrônico (DTE).

ER308

C9 Funcionalidade não permitida para o CNPJ do Governo do Distrito Federal. ER075

5.6 Validação de Regra de Negócio para Certificado Digital de Assinatura

# Regra de Validação Msg

29

Page 30: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

D1 Certificado Assinatura Inválido: ­ Certificado Assinatura inexistente no xml

ER400

D2 Validade do Certificado (data início e data fim) ER401

D3 Falta a extensão de CNPJ no Certificado (OtherName ­ OID=2.16.76.1.3.3) ER402

D4 LCR do Certificado de Assinatura: ­ Falta o endereço da LCR (CRLDistributionPoint) ­ Erro no acesso a LCR ou LCR inexistente

ER403

D5 Certificado Assinatura revogado ER404

D6 Certificado Raiz difere da "ICP­Brasil" ER405

D7 CNPJ não pertence a uma prefeitura ER074

D8 CNPJ do Certificado Assinatura difere do CNPJ do Certificado Transmissão ER408

5.7 Validação de Regra de Negócio para Assinatura

# Regra de Validação Msg

A1 Valor da assinatura (SignatureValue) difere do valor calculado ER500

5.8 Final do Processamento O final do processamento dos documentos (Alvará, Habite­se ou Declaração de sem movimento) enviados poderá resultar em:

Rejeição: o documento será descartado, não sendo armazenado no banco de dados. Pode ser corrigido e enviado novamente.

Sucesso: o documento será armazenado no banco de dados. Para cada documento com “Sucesso” será atribuído um número de protocolo (vide regra de formação no item 5.9).

5.9 Número de Protocolo

30

Page 31: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

Todo documento processado com “Sucesso” terá um protocolo que será enviado no arquivo de retorno para as prefeituras. O número de protocolo tem a seguinte formação:

Código do município

Tipo do documento

Ano Mês Dia ID do

documento

DV

Quantidade de

caracteres

6 1 4 2 2 9 1

Código do município: Código do município da tabela TOM Tipo do documento: Alvará, Habite­se ou DSM Ano: ano da data do momento do cadastro Mês: mês da data do momento do cadastro Dia: dia da data do momento do cadastro ID do documento: número sequencial gerado automaticamente pelo sistema DV: dígito verificador baseado em um cálculo do módulo 11

6.0 Categorias da Obra Para Área Principal e Área Complementar existem as seguintes categorias de obras: Obra nova, Acréscimo, Reforma, Demolição e Existente que serão possíveis nas seguintes combinações:

1 ­ Obra Nova 2 ­ Acréscimo e Existente 3 ­ Acréscimo, Reforma e Existente 4 ­ Acréscimo, Demolição e Existente 5 ­ Acréscimo, Reforma, Demolição e Existente 6 ­ Reforma e Existente 7 ­ Reforma, Demolição e Existente 8 ­ Demolição e Existente 9 ­ Obra Nova, Demolição e Existente* * Apenas se a área de demolição for igual à existente.

31

Page 32: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

7.0 Tabela de Códigos e Descrições de Mensagens

Código Tipo Descrição da mensagem

IN001 Sucesso Dados salvos com sucesso

IN003 Sucesso $TIPO_DE_DOCUMENTO$ cancelado com sucesso. Protocolo número: $PROTOCOLO$

IN004 Sucesso $TIPO_DE_DOCUMENTO$ reativado com sucesso. Protocolo número: $PROTOCOLO$

IN006 Sucesso Declaração de Sem Movimento para a competência $COMPETENCIA$ enviada com sucesso.

ER001 Rejeição do lote

Falha ao processar operação

ER003 Rejeição do documento

$NOME_DO_CAMPO$ inválido.

ER004 Rejeição do documento

Campo obrigatório em branco ($NOME_DO_CAMPO$).

ER005 Rejeição do documento

A Data do Final da Obra deve ser menor ou igual a Data do Habite­se.

ER008 Rejeição do documento

A Data do Final de Obra deve ser posterior à Data de Início da Obra.

ER029 Rejeição do documento

Para destinação "Casa Popular" a soma das áreas não pode ser maior que 70m².

ER035 Rejeição do documento

Problemas ao consultar TOM­Web

ER036 Rejeição do documento

CEP com formato inválido

ER039 Rejeição Para destinação "Conjunto Habitacional Popular" a soma da área

32

Page 33: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

do documento

principal dividida pela quantidade total de unidades não pode ser maior que 70m². A destinação deve ser "Residencial Multifamiliar".

ER042 Rejeição do documento

O alvará de número $NUMERO$ já está cadastrado. O número do alvará não poderá repetir no período do ano para uma mesma prefeitura.

ER047 Rejeição do documento

O habite­se de número $NUMERO$ já está cadastrado. O número do habite­se não poderá repetir no período do ano para uma mesma prefeitura.

ER048 Rejeição do documento

Já existe um habite­se total cadastrado para o alvará $NUMERO_ALVARA$.

ER049 Rejeição do documento

A área do habite­se total ($AREA_HABITESE$ m²) deve ser igual a área do alvará ($AREA_ALVARA$ m²).

ER050 Rejeição do documento

O valor da unidade de medida do habite­se total ($VALOR$ $UNIDADE_MEDIDA$) deve ser igual ao valor da unidade de medida do alvará ($VALOR$ $UNIDADE_MEDIDA$).

ER053 Rejeição do documento

A área total do habite­se parcial ($AREA_HABITESE$ m²) deve ser menor que a área do alvará ($AREA_ALVARA$ m²).

ER054 Rejeição do documento

O valor da unidade de medida do habite­se parcial ($VALOR$ $UNIDADE_MEDIDA$) deve ser menor que o valor da unidade de medida do alvará ($VALOR$ $UNIDADE_MEDIDA$).

ER057 Rejeição do documento

O alvará $NÚMERO$ possui habite­se total vinculado e não pode ter os dados da obra retificada.

ER058 Rejeição do documento

O alvará $NÚMERO$ possui habite­se vinculado e não pode ter a unidade de medida retificada.

ER059 Rejeição do documento

O dados da obra do alvará $NUMERO$ possui um valor menor ou igual a metragem do habite­se parcial vinculado.

ER060 Rejeição do documento

O alvará $NUMERO$ possui habite­se vinculado e não pode ter os dados da obra retificados.

ER061 Rejeição CNPJ da empresa construtora não pode ser o mesmo que o

33

Page 34: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

do documento

proprietário do imóvel.

ER062 Rejeição do documento

Construção em Nome Coletivo é obrigatório que exista mais de um CNPJ/CPF cadastrado e um deles deve ser o principal.

ER064 Rejeição do documento

CNPJ do Consórcio não pode ser o mesmo CNPJ da Empresa Líder de Consórcio.

ER065 Rejeição do documento

Ao menos uma metragem deve ser informada.

ER066 Rejeição do documento

A Data do Habite­se deve ser posterior a Data do Alvará vinculado.

ER068 Rejeição do documento

Para Construção em Nome Coletivo os campos CPF/CNPJ dos responsáveis devem ter valores diferentes.

ER070 Rejeição do documento

O alvará $NÚMERO$ já possui habite­se parcial vinculado.

ER074 Rejeição do lote

CNPJ não pertence a uma prefeitura.

ER075 Rejeição do lote

Funcionalidade não permitida para o CNPJ do Governo do Distrito Federal.

ER200 Rejeição do lote

Falha no schema XML: $ERRO$

ER201 Rejeição do lote

Tamanho da mensagem excedeu o limite estabelecido.

ER202 Rejeição do documento

Campo "numeroProtocoloAnterior" é obrigatório para alvará de retificação.

ER203 Rejeição do documento

Alvará não encontrado.

ER204 Rejeição do

Habite­se não encontrado.

34

Page 35: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

documento

ER213 Rejeição do documento

CPF não encontrado na base de dados do Cadastro de Pessoa Física.

ER214 Rejeição do documento

CNPJ não encontrado na base de dados do Cadastro Nacional de Pessoa Jurídica.

ER215 Rejeição do documento

O $TIPO_DOCUMENTO$ $NUMERO_DOCUMENTO$ já estava cancelado.

ER216 Rejeição do documento

O $TIPO_DOCUMENTO$ $NUMERO_DOCUMENTO$ já estava ativo.

ER218 Rejeição do documento

Preencher o campo quantidade total de unidades por bloco apenas quando a destinação for "Conjunto Habitacional Popular".

ER220 Rejeição do documento

Para destinação "Conjunto Habitacional Popular" é necessário informar a quantidade total de unidades dos blocos.

ER221 Rejeição do lote

Todos os documentos contidos no lote deverão pertencer ao mesmo mês e ano.

ER222 Rejeição do documento

CPF do $CAMPO$ não encontrado.

ER223 Rejeição do documento

CNPJ do $CAMPO$ não encontrado.

ER224 Rejeição do lote e do documento

Versão do XML inválida.

ER229 Rejeição do documento

CEP da Obra não encontrado.

ER230

Rejeição do documento

Existe mais de uma área principal com a categoria $CATEGORIA$ e destinação $DESTINACAO$.

35

Page 36: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

ER232 Rejeição do documento

Combinação de categoria não permitida.

ER236 Rejeição do documento

CEP da obra deve ser do mesmo município da prefeitura.

ER239 Rejeição do documento

O ano do alvará não pode ser alterado.

ER240 Rejeição do documento

O número do alvará não pode ser alterado.

ER244 Rejeição do documento

Área $AREA$ informada no(s) habite­se ($SOMA_AREA$) ultrapassa a informada no alvará($AREA_INFORMADA$).

ER253 Rejeição do documento

Para Obra Nova e Conjunto Habitacional Popular a quantidade de unidades tem que ser maior que 1.

ER254 Rejeição do documento

Não é possível reativar o habite­se porque o alvará vinculado tem a unidade de medida diferente.

ER255 Rejeição do documento

Área $AREA$ informada no habite­se não foi encontrada no alvará.

ER256 Rejeição do documento

Unidade de medida informada no habite­se diferente da encontrada no alvará.

ER266 Rejeição do documento

Documento não encontrado.

ER275 Rejeição do documento

Ano/mês não corresponde com o atributo Id da tag infDsm.

ER276 Rejeição do documento

Ocorreu erro no preenchimento dos dados da obra . As possibilidades permitidas pelo sistema estão na tabela Anexo I do manual.

36

Page 37: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

ER300 Rejeição do lote

Certificado Transmissor inválido

ER301 Rejeição do lote

Certificado Transmissor ­ Data inválida

ER302 Rejeição do lote

Certificado Transmissor sem CNPJ

ER303 Rejeição do lote

Certificado Transmissor ­ Erro no acesso a LCR

ER304 Rejeição do lote

Certificado Transmissor revogado

ER305 Rejeição do lote

Certificado Transmissor ­ Cadeia inválida

ER308 Rejeição do lote

Certificado Transmissor ­ CNPJ não é optante pelo Domicílio Tributário Eletrônico (DTE).

ER400 Rejeição do documento

Certificado Assinatura inválido

ER401 Rejeição do documento

Certificado Assinatura ­ Data inválida

ER402 Rejeição do documento

Certificado Assinatura sem CNPJ

ER403 Rejeição do documento

Certificado Assinatura ­ Erro no acesso a LCR

ER404 Rejeição do documento

Certificado Assinatura revogado

ER405 Rejeição do documento

Certificado Assinatura ­ Cadeia inválida

ER408 Rejeição do documento

CNPJ do Certificado Assinatura difere do CNPJ do Certificado Transmissão

37

Page 38: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

ER500 Rejeição do documento

Assinatura inválida

38

Page 39: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

8.0 Tabela de endereços dos web services disponíveis. Ambiente de Pré­produção

Serviço URL

recepcaoLote https://sisobrapref.pre.receita.fazenda.gov.br/sisobraprefWS/recepcao

recepcaoDSM https://sisobrapref.pre.receita.fazenda.gov.br/sisobraprefWS/recepcao

consultarDocumento https://sisobrapref.pre.receita.fazenda.gov.br/sisobraprefWS/recepcao

Ambiente de Produção ( a definir)

Serviço URL

recepcaoLote https://www.sisobrapref.fazenda.gov.br/recepcao

recepcaoDSM https://www.sisobrapref.fazenda.gov.br/recepcao

consultarDocumento https://www.sisobrapref.fazenda.gov.br/recepcao

39

Page 40: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

9.0 Anexo I Área Principal Possibilidades das Categorias e Características (Destinação, Tipo, Áreas, etc) das Obras apenas com Áreas Principais

Obra Nova ­ Caso a categoria da obra seja apenas obra nova, ela poderá possuir uma ou mais características. Obra Nova com Demolição e Existente ­ Caso a obra nova não seja categoria única, ela poderá ser concomitante apenas com as categorias demolição e área existente e desde que todas as características da demolição sejam idênticas a da área existente. Acréscimo e Existente ­ O acréscimo poderá não ter as mesmas características da obra existente, ou poderá ter uma ou mais características da obra existente, desde que não possua área zerada.

Reforma e Existente ­ A reforma poderá não ter as mesmas características da obra existente, ou poderá ter uma ou mais características da obra existente, desde que não possua área zerada e a área de reforma não seja maior que a área existente. Acréscimo, Reforma e Existente ­ O acréscimo e reforma podem não ter as mesmas características da obra existente, ou podem ter uma ou mais características da obra existente, desde que não possuam área zerada e a área da reforma não seja maior que a área existente.

Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área de demolição que deverá ser menor ou igual que a área existente.

Acréscimo, Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área que deverá ser menor que a área total da obra existente. ­ O acréscimo poderá não apresentar as mesmas características da obra existente, ou poderá, ainda, ter uma ou mais características da obra existente, desde que não possua área zerada. Reforma, Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à

40

Page 41: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

exceção da área que deverá ser menor que a área da obra existente. ­ A reforma pode não apresentar as mesmas características da obra existente, ou pode, ainda, ter uma ou mais características da obra existente, à exceção da área que deverá ser menor ou igual à diferença entre a área existente e a área demolida.

Acréscimo, Reforma, Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área que deverá ser menor que a área da obra existente. ­ A reforma pode não apresentar as mesmas características da obra existente, ou pode, ainda, ter uma ou mais características da obra existente, à exceção da área que deverá ser menor ou igual à diferença entre a área existente e a área demolida. ­ O acréscimo pode não apresentar as mesmas características da obra existente, ou pode, ainda, ter uma ou mais características da obra existente, desde que não possua área zerada.

Obs: Entende­se por Características da obra o conjunto de informações relativas a: destinação, tipo, área, etc. Área Complementar Possibilidades das Categorias e Características (Destinação, Tipo, Áreas, etc) das Obras apenas com Áreas Complementares

Obra Nova ­ Caso a categoria da obra seja apenas obra nova, ela poderá possuir uma ou mais características. Obra Nova com Demolição e Existente ­ Caso a obra nova não seja categoria única, ela poderá ser concomitante apenas com as categorias demolição e área existente e desde que todas as características da demolição sejam idênticas a da área existente.

Acréscimo e Existente ­ O acréscimo pode não apresentar as mesmas características da obra existente, ou pode, ainda, ter uma ou mais características da obra existente, desde que não possua área zerada.

Reforma e Existente ­ A reforma poderá não ter as mesmas características da obra existente, ou poderá ter uma ou mais características da obra existente, desde que não

41

Page 42: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

possua área zerada e a área de reforma não seja maior que a área existente.

Acréscimo, Reforma e Existente ­ O acréscimo e reforma podem não ter as mesmas características da obra existente, ou podem ter uma ou mais características da obra existente, desde que não possuam área zerada e a área da reforma não seja maior que a área existente.

Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área coberta e/ou descoberta de demolição que deverá (ão) ser menor ou igual à área coberta e/ou descoberta da obra existente. Acréscimo, Demolição e Existente ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área, quando houver acréscimo. Neste caso, a área coberta e/ou descoberta da demolição deverá ser menor que a área coberta e/ou descoberta da obra existente. ­ O acréscimo poderá não apresentar as mesmas características da obra existente, ou poderá, ainda, ter uma ou mais características da obra existente, desde que não possua área zerada.

Reforma, Demolição e Existente ­ A reforma e demolição poderão ter uma ou mais características da obra existente. ­ A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área, quando houver reforma. Neste caso, a área coberta e/ou descoberta da demolição deverá ser menor que a área coberta e/ou descoberta da obra existente. ­ Além disso, a área da reforma não deverá ser maior que a diferença entre a área total da obra existente e a área total de demolição. Acréscimo, Reforma, Demolição e Existente ­ A reforma, a demolição e o acréscimo poderão ter uma ou mais características da obra existente. ­ Todas as características da demolição deverão ser iguais às características correspondentes da área existente, com exceção da área, quando houver reforma ou acréscimo. Nestes casos, a área coberta e/ou descoberta da demolição deverá ser menor que a área coberta e/ou descoberta da obra

42

Page 43: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

existente. ­ A reforma poderá não ter as mesmas características da obra existente, ou poderá ter uma ou mais características da obra existente, desde que não possua área zerada. Além disso, a área resultante da reforma não deverá ser maior que a diferença entre a área total da obra existente e a área de demolição.

Obs: Entende­se por Características da obra o conjunto de informações relativas a: destinação, tipo, área coberta, descoberta, etc. Área Principal e Área Complementar Possibilidades das Categorias e Características (Destinação, Tipo, Áreas, etc) das Obras com Áreas Principais e Complementares

Obra Nova ­ Caso a categoria da obra seja apenas obra nova, tanto para a Área Principal e/ou para Área Complementar, ela poderá possuir quaisquer das características possíveis.

Obra Nova com Demolição e Existente ­ A obra nova poderá ser feita na Área Principal e/ou na Área Complementar. Caso a obra nova não seja categoria única, ela poderá ser concomitante apenas com as categorias demolição e área existente e desde que todas as características da demolição sejam idênticas a da área existente.

Acréscimo e Existente ­ O acréscimo poderá ser feito na Área Principal e/ou na Área Complementar. ­ Se o acréscimo for feito na Área Principal, a obra existente deverá estar necessariamente na Área Principal e opcionalmente na Área Complementar, quaisquer que sejam as características da obra existente e do acréscimo, desde que este último não apresente área zerada. ­ Se o acréscimo for feito na Área Complementar, a obra existente deverá estar necessariamente na Área Complementar e opcionalmente na Área Principal, quaisquer que sejam as características da obra existente e do acréscimo, desde que este último não apresente área zerada.

Reforma e Existente

43

Page 44: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

­ A reforma poderá ser feita na Área Principal e/ou na Área Complementar. ­ Se a reforma for feita na Área Principal, a obra existente deverá estar necessariamente na Área Principal e opcionalmente na Área Complementar, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente. ­ Se a reforma for feita na Área Complementar, a obra existente deverá estar necessariamente na Área Complementar e opcionalmente também na Área Principal, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente.

Acréscimo, Reforma e Existente ­ Se o acréscimo e a reforma forem feitos na Área Principal, a obra existente necessariamente estará na Área Principal e opcionalmente também na Área Complementar. ­ Se o acréscimo e a reforma forem feitos na Área Complementar, a obra existente necessariamente deverá estar na Área Complementar e opcionalmente também na Área Principal. ­ As áreas de acréscimo, reforma e existente podem possuir quaisquer características, porém a área resultante da reforma deverá ser menor ou igual a área da obra existente.

Demolição e Existente ­ A obra existente poderá estar na Área Principal e/ou na Área Complementar. A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área de demolição que deverá ser menor ou igual à área da obra existente.

Acréscimo, Demolição e Existente ­ A obra existente poderá estar na Área Principal e/ou na Área Complementar. A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área de demolição que deverá ser menor ou igual à área da obra existente. ­ Quando houver demolição e acréscimos concomitantes, a área demolida somente poderá ser igual a área da obra existente se houver outra obra existente com características diversas da área existente demolida completamente. ­ Se a obra existente estiver na Área Principal o acréscimo estará na Área Principal e opcionalmente também na Área Complementar.

44

Page 45: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

­ Se a obra existente estiver na Área Complementar o acréscimo estará na Área Complementar e opcionalmente também na Área Principal. ­ A demolição deverá ocorrer ao menos em uma das categorias das áreas existentes.

Reforma, Demolição e Existente ­ A obra existente poderá estar na Área Principal e/ou na Área Complementar. A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área de demolição que deverá ser menor ou igual à área da obra existente. ­ Quando houver demolição e acréscimos concomitantes, a área demolida somente poderá ser igual a área da obra existente se houver outra obra existente com características diversas da área existente demolida completamente. ­ Se a reforma for feita na Área Principal, a obra existente deverá estar necessariamente na Área Principal e opcionalmente na Área Complementar, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente. ­ Se a reforma for feita na Área Complementar, a obra existente deverá estar necessariamente na Área Complementar e opcionalmente também na Área Principal, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente. ­ A demolição deverá ocorrer ao menos em uma das categorias das áreas existentes.

Acréscimo, Reforma, Demolição e Existente ­ A obra existente poderá estar na Área Principal e/ou na Área Complementar. A demolição deverá ter exatamente as mesmas características da obra existente, à exceção da área de demolição que deverá ser menor ou igual à área da obra existente. ­ Quando houver demolição e acréscimos concomitantes, a área demolida somente poderá ser igual a área da obra existente se houver outra obra existente com características diversas da área existente demolida completamente. ­ Se a obra existente estiver na Área Principal o acréscimo estará na Área Principal e opcionalmente também na Área Complementar. ­ Se a obra existente estiver na Área Complementar o acréscimo estará na Área Complementar e opcionalmente também na Área Principal.

45

Page 46: Manual Web Service SisobraPref - Receita Federalreceita.economia.gov.br/orientacao/tributaria/de... · Meio lógico de comunicação Web Services disponibilizado pela RFB. Meio físico

­ Se a reforma for feita na Área Principal, a obra existente deverá estar necessariamente na Área Principal e opcionalmente na Área Complementar, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente. ­ Se a reforma for feita na Área Complementar, a obra existente deverá estar necessariamente na Área Complementar e opcionalmente também na Área Principal, quaisquer que sejam as características da obra existente e da reforma, desde que esta última não apresente área maior que a área da obra existente. ­ A demolição deverá ocorrer ao menos em uma das categorias das áreas existentes.

Obs: Entende­se por Características da obra o conjunto de informações relativas a: destinação, tipo, área coberta, descoberta, etc.

46