anexo_v_-_nfse_termo_de_referencia_tecnico_-_versao_20_08_2015

7/26/2019 anexo_v_-_nfse_termo_de_referencia_tecnico_-_versao_20_08_2015

1/26

ANEXO VTERMO DE REFERNCIA TCNICO DA NFSE

1 - PREMISSAS E REGRAS DE NEGCIO

1.1- Regras gerais para gerao da NFSE

A NFSE deve conter a identificao dos servios em conformidade com os itens da Lista deServios, anexa Lei Complementar n116/03, acrescida daqueles que foram vetados e de um item9999para outros servios.

O sistema permite a descrio de vrios servios numa mesma NFSE, desde que relacionados aum nico item da Lista, de mesma alquota e para o mesmo tomador de servio. Quando alegislao do municpio assim exigir, no caso da atividade de construo civil, as NFSE devero seremitidas por obra.

A identificao do prestador de servios ser feita pelo CNPJ, que pode ser conjugado com a

Inscrio Municipal, no sendo esta informao obrigatria.

A informao do CNPJ do tomador do servio obrigatria para a emisso de documentos fiscaispara pessoa jurdica, exceto quando se tratar de tomador do exterior.

A competncia de uma NFSE o ms da ocorrncia do fato gerador. O sistema assumirautomaticamente o ms/ano da emisso do RPS - Registro de Prestao de Servio ou da NFSE, oque for inferior, podendo ainda o contribuinte informar uma competncia anterior. Exemplo prtico:caso o contribuinte tenha prestado um servio no ms anterior e esteja gerando o XML do RPS hoje,dever indicar como do RPS a data da prestao do servio. Quando a Prefeituragerar a NFSE, assumir como data da competncia a data informada no RPS (veja a estrutura dedadosTcInfRps)

O valor lquido da NFSE calculado pelo valor total de servios subtraindo-se: valor do PIS,COFINS, INSS, IR, CSLL, outras retenes, ISS retido, desconto incondicionado e descontocondicionado.

A base de clculo da NFSE o valor total de servios, subtrado do valor de dedues previstas emlei e do desconto incondicionado.

O valor do ISSQN definido de acordo com a natureza da operao, a opo pelo simplesnacional, o regime especial de tributao e o ISS retido, e ser sempre calculado, exceto nosseguintes casos:

o A natureza da operao for tributao no municpio; exigibilidade suspensa por decisojudicial ou exigibilidade suspensa por procedimento administrativo e o regime especial detributao for estimativa, sociedade de profissionais ou MEI do simples nacional.

o A natureza da operao for tributao fora do municpio, nesse caso os campos alquota deservio e valor do ISSQN ficaro abertos para o prestador indicar os valores.

o A natureza da operao for imune ou isenta, nesses casos o ISSQN ser calculado comalquota zero.

o O contribuinte for optante pelo simples nacional e no tiver o ISSQN retido na fonte.

A alquota do ISSQN definida pela legislao municipal.


2/26

1.2- Processo de envio de RPS Registro de Prestao de Servios.

O envio de RPS Registro de Prestao de Servios Secretaria da Fazenda para geraodaNFSE s poder ser feito em lotes, ou seja, vrios RPS agrupados para gerar uma NFSEpara cada um deles.

Com base nessa circunstncia, o servio de recepo de lote de RPS ser definido comoAssncrono.

Como comprovante de envio de lote de RPS, o contribuinte receber apenas um nmero deprotocolo de recebimento. O lote recebido pela Secretaria da Fazenda ser colocado em umafila de processamento, e ser executado em momento oportuno. Depois de processado,gerar um resultado que estar disponvel ao contribuinte. Esse resultado poder ser as NFS- ecorrespondentes ou a lista de erro(s) encontrado(s) no lote.

A numerao dos lotes de RPS de responsabilidade do contribuinte, devendo ser nica edistinta para cada lote.

No servio de Recepo do Lote, um nico erro provoca a rejeio de todo o lote.

1.2.1 - ESTRUTURA DE DADOS

As principais estruturas do sistema so as da NFSE e do RPS, de acordo com o Modelo Conceitualdefinido pelaABRASF.LegendaINFORMACAO IDENTIFICACAO DA INFORMACAO

OC Ocorrncia Nmero de vezes que a informao pode ser apresentada.Descricao Breve descrio a respeito da identificao da informao.Ob Obrigatrio Obrigatoriedade de preenchimentoTip Tipo Nnumrico

C caracteresDData/Hora

Tam

Tamanho

Quantidade mxima de caracteres ou preciso numrica, dependendo do tipode informao.

1.2.1.1 - NOTA FISCAL DE SERVIOS ELETRNICAINFORMACAO OC. DESCRICAOIDENTIFICACAO DA NFSE

CONSOL.Ob

Tip

Tam

Assinatura 1-1 Assinatura digital S Item 2.2.3NumeroNFSe 1-1 Nmero da NFSE, formado pelo ano com 04 (quatro) dgitos e

um nmero sequencial com 11 posies FormatoAAAANNNNNNNNNNN.

S N 15

CdigoVerificacao 1-1 Cdigo da Verificao da NFSE S C 9DataEmissaoNFSe 1-1 Data/Hora da emisso da NFSE (AAAA-MM-DDTHH:mm:ss). S D 0Competencia 1-1 Ms e ano da prestao de servio. (AAAAMM). S N 6NumeroNFSeSubstituda 0-1 Nmero da NFSE substituda. N N 15

NaturezadaOperacao

1-1

1Tributao no municpio; 2 Tributao fora do municpio;3 Iseno; 4 Imune; 5 Exigibilidade suspensa pordeciso judicial; 6 Exigibilidade suspensa por procedimentoadministrativo.

S

N

2

RegimeEspecialTributacao 0-1 1 Microempresa Municipal; 2 Estimativa; 3 Sociedadede Profissionais; 4Cooperativa; 5MEISimples Nacional;

6ME EPPSimples Nacional.

N N 2

OptanteSimplesNacional 1-1 1Sim; 2No S N 1IncentivadorCultural 1-1 1Sim; 2No S N 1NumeroRPS 0-1 Nmero do RPS. Campo Obrigatrio apenas para NFSE

geradas pela emisso de RPS.N N 15

SerieRPS 0-1 Nmero do equipamento emissor do RPS ou srie do RPS. N C 5TipoRPS 0-1 1 Registro de Prestao de Servios; 2 Nota Fiscal

Conjugada (Mista); 3Cupom. Campo Obrigatrio apenas paraNFSE geradas pela emisso de RPS.

N N 1

DataEmissaoRPS 0-1 Data da emisso do RPS (AAAA-MM-DD). Campo Obrigatrioapenas para NFSE geradas pela emisso de RPS.

N D 0

Outrasinformacoes 0-1 Uso da administrao fazendria N C 255


3/26

IDENTIFICACAO DA PRESTACAO DO SERVICO Ob Tip Tam

ValorServicos 1-1 Valor dos servios em R$. S N 15,2ValorDeducoes 0-1 Valor das dedues para Reduo da Base de Clculo em R$. N N 15,2ValorPIS 0-1 Valor da reteno do PIS em R$. I nformao declaratria. N N 15,2ValorCOFINS 0-1 Valor da reteno do COFINS em R$. Informao declaratria. N N 15,2ValorINSS 0-1 Valor da reteno do INSS em R$. Informao declaratria. N N 15,2ValorIR 0-1 Valor da reteno do IR em R$. Informao declaratria. N N 15,2ValorCSLL 0-1 Valor da reteno do CSLL em R$. Informao declaratria. N N 15,2ItemListaServico 1-1 Cdigo do servio prestado. Item da LC 116/2003 S C 5

CodigoCNAE

0-1

CNAE 2.0

N

C

7

CodigoTributacaoMunicpio

1-1

Cdigo do servio prestado prprio do municpio

S

C

20

BaseCalculo 0-1 (Valor dos servios - Valor dasdedues descontosincondicionados)

N N 15,2

AlquotaServicos 0-1 Alquota do servio prestado. N N 5,4ValorISS 0-1 Valor do ISS em R$. N N 15,2ValorLquidoNFSe 0-1 (ValorServicos - ValorPIS - ValorCOFINS - ValorINSS

ValorIR - ValorCSLL - OutrasRetenoes - ValorISSRetido -DescontoIncondicionado - DescontoCondicionado)

N N 15,2

OutrasRetencoes 0-1 Outras retenes na Fonte. Informao Declaratria N N 15,2ValorCredito 0-1 Valor do crdito gerado. N N 15,2ISSRetido 1-1 1 - Sim 2No S N 1ValorISSRetido 0-1 Valor do ISS a ser retido. N N 15,2ValorDescontoIncondicionado 0-1 N N 15,2ValorDescontoCondicionado 0-1 N N 15,2Discriminacao 1-1 Discriminao dos servios. S C 2000MunicipioPrestacaoServico 1-1 Cdigo do municpio onde o servio foi prestado (tabela

do IBGE), se exterior colocar 9999999

S N 7

IDENTIFICACAO DO PRESTADOR DO SERVICO Ob Tip TamInscricaoPrestador 1-1 Inscrio municipal do prestador que emitiu a NFSE S C 15RazaoSocialPrestador 1-1 Razo Social do prestador do servio S C 115NomeFantasiaPrestador 0-1 Nome Fantasia do prestador do servio N C 60CNPJPrestador 1-1 Nmero do CNPJ do prestador do servio S C 14EndereoPrestador 1-1 Tipo e nome do logradouro (Av.., Rua..., ...) S C 125NumeroEnderecoPrestador 1-1 Nmero do imvel S C 10ComplementoEndereoPrestador 0-1 Complemento do endereo do prestador N C 60BairroPrestador 1-1 Bairro do prestador S C 60CidadePrestador 1-1 Cdigo do municpio do estabelecimento prestador do servio

(Tabela do IBGE)

S N 7

UFPrestador 1-1 Sigla da unidade da federao do prestador S C 2CepPrestador 1-1 Nmero do CEP S N 8EmailPrestador 0-1 E-mail do prestador N C 80TelefonePrestador 0-1 Nmero do telefone do prestador N C 11

IDENTIFICACAO DO TOMADOR DO SERVICO Ob Tip TamCPFCNPJTomador 0-1 CPF/CNPJ do tomador do servio. Obrigatrio para CNPJ N C 14IndicacaoCPFCNPJ 0-1 1 - CPF 2 - CNPJ 3 - No Informado N N 1InscricaoMunicipalTomador 0-1 Este elemento s dever ser preenchido para tomadores

cadastrados no municpio.N C 15

RazaoSocialTomador 1-1 Nome / Razo Social do tomador. S C 115EnderecoTomador 1-1 Tipo e nome do logradouro (Av.., Rua..., ...) S C 125NumeroEnderecoTomador 1-1 Nmero do Imvel S C 10ComplementoEnderecoTomador 0-1 Complemento do Endere o do tomador N C 60BairroTomador 1-1 Bairro do tomador S C 60CidadeTomador 1-1 Cdigo do municpio onde o tomador est estabelecido (Tabela

do IBGE)S N 7

UFTomador 1-1 Sigla da unidade da federao do tomador S C 2CepTomador 1-1 Nmero do CEP S N 8EmailTomador 0-1 E-mail do tomador N C 80TelefoneTomador 0-1 Nmero do telefone do tomador N C 11


4/26

IDENTIFICACAO DO INTERMEDI RIO DO SERVIO Ob Tip Tam

RazaoSocialIntermediarioServico 0-1 Nome ou Razo Social de intermedirio do servio N C 115InscricaoMunicipalIntermediarioServico 0-1 Nmero da inscrio municipal do intermedirio do servio N C 15

CNPJIntermediarioSevico 0-1 Nmero do CNPJ do intermedirio do servio N C 14

IDENTIFICACAO DO ORGAO GERADOR Ob Tip TamCodigodoMunicipioGerador 1-1 Cdigo do IBGE S N 7UFdoMunicipioGerador 1-1 Sigla da unidade da federao do municpio gerador da NFSE S C 2

DETALHAMENTO ESPECIFICO DA CONTRUCAO CIVIL Ob Tip TamCodigodaObra 0-1 Numero da matricula CEI da obra ou daempresa N C 15

ART 0-1 Numero da ART N C 15

1.2.2.2 - REGISTRO DE PRESTAO DE SERVIOS - RPSINFORMAC O OC. DESCRIC O CONSOL.IDENTIFICACAO DO RPS Ob Tip TamAssinatura 1-1 Assinatura digital S Item 2.2.3NaturezadaOperacao 1-1 1Tributao no municpio; 2 Tributao fora do municpio;

3 Iseno; 4 Imune; 5 Exigibilidade suspensa pordeciso judicial; 6 - Exigibilidade suspensa por procedimentoadministrativo.

S N 2

RegimeEspecialTributacao 0-1 1 Microempresa Municipal; 2 Estimativa; 3 Sociedadede Profissionais; 4 Cooperativa; 5 MEI Simples

Nacional; 6 ME EPPSimples Nacional.

N N 2

OptanteSimplesNacional

1-1

1 Sim; 2No

S

N

1

IncentivadorCultural 1-1 1 Sim; 2No S N 1NumeroRPS 1-1 Nmero do RPS. S N 15SerieRPS 1-1 Nmero do equipamento emissor do RPS ou srie do RPS. S C 5TipoRPS 1-1 1Registro de Prestao de Servios; 2Nota Fiscal

Conjugada (Mista); 3Cupom.S N 1

DataEmissaoRPS 1-1 Data da emisso do RPS (AAAA-MM-DD). S D 0StatusRPS 1-1 1 Normal; 2Cancelado S N 1NumeroRPSSubstituido 0-1 Nmero do RPS substitudo N N 15SerieRPSSubstituido 0-1 Nmero do equipamento emissor do RPS ou srie do RPS

substitudo.N C 5

IDENTIFICACAO DA PRESTACAO DO SERVICOValorServicos 1-1 Valor dos servios em R$. S N 15,2ValorDeducoes 0-1 Valor das dedues para Reduo da Base de Clculo em R$. N N 15,2ValorPIS 0-1 Valor da reteno do PIS em R$. I nformao declaratria. N N 15,2

ValorCOFINS

0-1

Valor da reteno do COFINS em R$. Informao declaratria.

N

N

15,2ValorINSS 0-1 Valor da reteno do INSS em R$. Informao declaratria. N N 15,2

ValorIR 0-1 Valor da reten o do IR em R$. Informa o declaratria. N N 15,2ValorCSLL 0-1 Valor da reteno do CSLL em R$. Informao declaratria. N N 15,2ItemListaServico 1-1 Cdigo do servi o prestado. Item da LC 116/2003 S C 5CodigoCNAE 0-1 CNAE 2.0 N C 7CodigoTributacaoMunicipio 1-1 Cdigo do servio prestado prprio do municpio S C 20BaseCalculo 0-1 (Valor dos servios - Valor das dedues descontos

incondicionados)N N 15,2

AliquotaServicos 0-1 Alquota do servio prestado. N N 5,4ValorISS 0-1 Valor do ISS em R$. N N 15,2ValorLiquidoNFSE 0-1 (ValorServicos - ValorPIS - ValorCOFINS - ValorINSS -

ValorIRValorCSLL - OutrasRetenoes - ValorISSRetido -Descont oIncondicionado - DescontoCondicionado)

N N 15,2

OutrasRetencoes 0-1 Outras retenes na Fonte. Informao Declaratria N N 15,2ISSRetido 1-1 1 - Sim 2No S N 1ValorISSRetido 0-1 Valor do ISS a ser retido. N N 15,2ValorDescontoIncondicionado

0-1

N

N

15,2ValorDescontoCondicionado 0-1 N N 15,2

Discriminacao 1-1 Discriminao dos servios. S C 2000MunicipioPrestacaoServico 1-1 Cdigo do municpio onde o servio foi prestado (tabela do

IBGE), se exterior colocar 9999999

S N 7


5/26

IDENTIFICACAO DO TOMADOR DO SERVICO

CPFCNPJTomador 0-1 CPF/CNPJ do tomador do servio. Obrigatrio para CNPJ N C 14IndicacaoCPFCNPJ 1-1 1 - CPF 2 - CNPJ 3 - No Informado S N 1InscricaoMunicipalTomador 0-1 Este elemento s dever ser preenchido para tomadores

cadastrados no municpio.N C 15

RazaoSocialTomador 1-1 Nome / Razo Social do tomador. S C 115EnderecoTomador 1-1 Tipo e nome do logradouro (Av.., Rua..., ...) S C 125NumeroEnderecoTomador 1-1 Nmero do Imvel S C 10ComplementoEnderecoTomador 0-1 Complemento do endereo do tomador N C 60

BairroTomador 1-1 Bairro do tomador S C 60CidadeTomador 1-1 Cdigo do municpio onde o tomador est estabelecido (Tabela

do IBGE)S N 7

UFTomador 1-1 Sigla da unidade da federao do tomador S C 2CepTomador 1-1 Nmero do CEP S N 8EmailTomador 0-1 E-mail do tomador N C 80TelefoneTomador 0-1 Nmero do telefone do tomador N C 11

IDENTIFICAC O DO INTERMEDI RIO DO SERVIORazaoSocialIntermediarioServico 0-1 Nome ou Razo Social de intermedirio doservio N C 115InscricaoMunicipalIntermediarioServico 0-1 Nmero da inscrio municipal do intermedirio doservio N C 15

CNPJIntermediarioServico 0-1 Nmero do CNPJ do intermedirio do servio N C 14

IDENTIFICACAO DO PRESTADOR DO SERVICO

InscricaoPrestador 1-1 Inscrio municipal do prestador que emitiu a NFSE S C 15

CNPJPrestador

1-1

Nmero do CNPJ do Prestador do Servio

S

C

14

DETALHAMENTO ESPECIFICO DA CONTRUCAO CIVILCodigodaObra 0-1 Nmero da matricula CEI da obra ou da empresa N C 15ART 0-1 Nmero da ART N C 15

Para a criao de aplicaes que manipulem estas estruturas deve ser consultado o XML Schemadisponvel no Portal da Nota Porto Alegre.


6/26

2 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE

2.1.1 Recepo e Processamento de Lote de Registros de Prestao de ServiosRPS para gerao de NFSE (mtodo assncrono de gerao da NFSE)

Esse servio compreende a recepo do lote de RPS, a resposta com o nmero do protocolo

gerado para esta transao e o processamento do lote. Quando efetuada a recepo, o loteentrar na fila para processamento posterior onde sero feitas as validaes necessrias egerao das NFSE.

Passos p ara exec uo

1- A aplicao acessa o servio de Recepo e Processamento de Lote de RPSenviando olote (fluxo b).2- A requisio recebida pelo servidor do Web Service que grava as informaes recebidas e gerao nmero de protocolo de recebimento (fluxo c).3- O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo d).

2.1.2 Gerao de NFSE (mtodo sncrono de gerao da NFSE)

Esse servio compreende a recepo do lote de at 3 (trs) RPS. Quando efetuada a recepo,o lote ser processado e sero feitas as validaes necessrias e gerao das NFSE.

IMPORTANTE

Este servio no parte integrante no Modelo Conceitual da ABRASF .


7/26

Passos pa ra exec uo1. A aplicao acessa o servio de Gerao de NFSE enviando o lote (fluxo 2.b).2. A requisio recebida pelo servidor do Web Service que grava as informaes recebidas

e processa o lote (fluxo 2.c).3. O Web Service retorna uma mensagem (a estrutura com a lista da NFSE geradas ouas mensagens de erro) com o resultado do processamento do servio (fluxo 2.d).

2.1.3 Consulta de Situao de Lote de RPS

Esse servio efetua a consulta da situao de um lote de RPS j enviado.

Passos p ara e xecuo

1. Submete os dados para processamento (fluxo 2.b).2. A requisio recebida pelo servidor do Web Service, que verifica os dados

preenchidos e identifica o status do lote (fluxos 2.ce 2.d).3. O Web Service retorna uma mensagem com o resultado do processamento do servio

(fluxo 2.e).

2.1.4 Consulta de NFSE por RPS Registro de Prestao de Servios

Esse servio efetua a consulta de uma NFSE a partir do nmero de RPS que a gerou.

Passos para exec uo1. A aplicao acessa o servio de Consulta de NFSE por RPSe submete os dados

para processamento (fluxo 2.b).2. A requisio recebida pelo servidor do Web Service, que verifica os dados

preenchidos e identifica a NFSE correspondente (fluxos 2.c e2.d).3. O Web Service retorna uma mensagem com o resultado do processamento do servio

(fluxo 2.e).


8/26

2.1.5 Consulta de Lote de RPS

Esse servio permite ao contribuinte obter as NFSE que foram geradas a partir do lote deRPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista de errose/ou inconsistncias encontradas nos RPS.Na validao do lote, devem ser retornados todos os erros verificados. Ocorrendo umaexcessiva quantidade de erros, haver um limitador para a quantidade de erros retornados.

Passos p ara e xec uo1. A aplicao acessa o servio de Consulta de Lote de RPS e submete os dadospara processamento (fluxo b).

2. A requisio recebida pelo servidor do Web Service, que verifica os dadospreenchidos e identifica as NFSE correspondentes (fluxos c ed).

3. O Web Service retorna uma mensagem (a estrutura com a lista da NFSE geradasou as mensagens de erro) com o resultado do processamento do servio (fluxo e).

2.1.6 Consulta de NFSE

Esse servio permite a obteno de determinada NFSE j gerada.

Passos p ara e xec uo1. A aplicao acessa o servio de Consulta de NFSEe submete os dados para

processamento (fluxo 2.b).2. A requisio recebida pelo servidor do Web Service, que verifica os dados

preenchidos e identifica as NFSE correspondentes.3. O Web Service retorna uma mensagem com o resultado do processamento do servio.


9/26

2.1.7 Cancelamento de NFSE

Esse servio permite o cancelamento direto de uma NFSE sem substituio da mesma poroutra. A substituio de NFSE est disponvel apenas atravs do aplicativo acessvel atravs dosite da Nota Legal Porto Alegre.

Passos p ara exec uo1. A aplicao acessa o servio de Cancelamento de NFSEe submete os dados para

processamento (fluxo 2.b).2. A requisio recebida pelo servidor do Web Service, que verifica os dados

preenchidos, identifica a NFSE correspondente e efetua o seu cancelamento (fluxo2.c).

3. O Web Service retorna uma mensagem com o resultado do processamento do servio(fluxo 2.d).

2.1.8 Consulta de NFSE por faixa

Esse servio permite a obteno de determinada NFSE j gerada.

Pas so s para execuo

1. A aplicao acessa o servio de Consulta de NFSE por faixa e submete os dados paraprocessamento (fluxo 2.b).

2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos eidentifica as NFSE correspondentes.3. O Web Service retorna uma mensagem com o resultado do processamento do servio.


10/26

2.2 - PADRES TCNICOS

2.2.1Pad

2.2.1 Padro de Comunicao

O meio fsico de comunicao utilizado entre o sistema de informao dos contribuintes e osistema da NFSE da Secretaria Municipal da Fazenda ser a Internet, com o uso do protocoloSSL, que alm de garantir um duto de comunicao seguro na Internet, permite a identificaodo servidor e do cliente atravs de certificados digitais, eliminando a necessidade deidentificao do usurio atravs de nome ou cdigo de usurio e senha.

O modelo de comunicao segue o padro de Web Services definido pelo WS-I Basic Profile.

A troca de mensagens entre o Web Service do Sistema da NFSE da Secretaria Municipalda Fazenda e o sistema do contribuinte ser realizada no padro SOAP, com troca demensagens XML no padro Style/Enconding: Document/Literal, wrapped. A opo wrappedrepresenta a chamada aos mtodos disponveis com a passagem de mais de um parmetro.Para descrever os servios disponibilizados, ser utilizado um documento WSDL (Web ServiceDescription Language). O WSDL o padro recomendado para descrio de servios SOAP.

RequerentedoServio

Provedordo Servio

SOAP


11/26

As chamadas aos servios sero feitas enviando como parmetro um documento XML aser processado pelo sistema. Esse documento no far parte da descrio do servio (arquivoWSDL), e o formato do XML correspondente ao servio dever ser consultado nesse manual.

2.2.2 Padro de Certificado Digital

Os certificados digitais utilizados no sistema da NFSE da Secretaria Municipal daFazenda sero emitidos por Autoridade Certificadora credenciada pela Infra-estruturade Chaves Pblicas Brasileira ICP-Brasil, de pessoa fsica ou jurdica, dos tipos

A1, A3 ou certificado de servidor (hbrido).

Para a assinatura digital dos documentos envolvidos aceitar-se- que o certificado digitalseja de quaisquer dos estabelecimentos da empresa.

Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao entre osistema do contribuinte e o Web Service da Secretaria Municipal da Fazenda:

Assinatura de Mensagens: O certificado digital utilizado para essa funo dever conter oCNPJ do estabelecimento emissor da NFSE ou o CNPJ do estabelecimento matriz. O

certificado digital dever ter o uso da chaveprevisto para a funo de assinatura digital,respeitando a Poltica do Certificado. Transmisso (durante a transmisso das mensagens entre os servidores do

contribuinte e os servios disponibilizados pela Secretaria Municipal da Fazenda): Ocertificado digital utilizado para identificao do aplicativo do contribuinte dever conter oCNPJ do responsvel pela transmisso das mensagens, mas no necessita ser o mesmoCNPJ do estabelecimento emissor da NFSE, devendo ter a extenso extended KeyUsage com permisso de Autenticao Cliente.

2.2.3 Padro de Assinatura Digital

As mensagens enviadas aos servios disponibilizados pela Secretaria Municipal daFazenda so documentos eletrnicos elaborados no padro XML e devem ser assinados

digitalmente com um certificado digital que contenha o CNPJ do estabelecimento matrizou o CNPJ do estabelecimento emissor da NFSE objeto do pedido.

Para garantir a integridade das informaes prestadas e a correta formao dosarquivos XML, o contribuinte dever submeter as mensagens XML para validaopela linguagem de Schema do XML (XSD XML Schema Definition), disponibilizadapela Secretaria Municipal da Fazenda antes de seu envio.

Os elementos a seguir esto presentes dentro do Certificado do contribuinte tornandodesnecessria a sua representao individualizada no arquivo XML. Portanto, o arquivoXML no deve conter os elementos:


12/26

Deve-se evitar o uso das TAGs a seguir, pois as informaes sero obtidas a partir doCertificado do emitente:

O Projeto NFSE utiliza um subconjunto do padro de assinatura XML definido peloW3C (http://www.w3.org/TR/xmldsig-core/), que tem o seguinte leiaute:

# Campo Elemento Pai Tipo Ocorrncia Descrio

XS01 Signature RaizXS02

Id

A

XS01

C

1-1

XS03 SignedInfo G XS01 1-1 Grupo da Informao da assinatura

XS04 CanonicalizationMethod G XS03 1-1 Grupo do Mtodo de Canonicalizao

XS05 Algorithm A XS04 C 1-1 Atributo Algorithm de CanonicalizationMethod:http://www.w3.org/TR/2001/REC-xml-c14n-20010315

XS06 SignatureMethod G XS03 1-1 Grupo do Mtodo de Assinatura

XS07 Algorithm A XS06 C 1-1 Atributo Algorithm de SignedInfo:http://www.w3.org/2000/09/xmldsig#rsa-

sha1

XS08 Reference G XS03 1-1 Grupo do Mtodo de ReferenceXS09 URI A XS08 C 1-1 Atributo URI da tag Reference

XS10 Transforms G XS08 1-1 Grupo do algorithm de Transform

XS11 Unique_Transf_Alg RC XS10 1-1 Regra para o atributo Algorithm do Transform sernico

XS12 Transform G XS10 2-2 Grupo de Transform

XS13 Algorithm A XS12 C 1-1 Atributos vlidos Algorithm do Transform:http://www.w3.org/TR/2001/REC-xml-c14n-20010315http://www.w3.org/2000/09/xmldsig#enveloped-signature

XS14

Xpath

E

XS12

C

0-N

Xpath

XS15 DigestMethod G XS08 1-1 Grupo do Mtodo de DigestMethod

XS16 Algorithm A XS15 C 1-1 Atributo Algorithm de DigestMethod:http://www.w3.org/2000/09/xmldsig#sha1

XS17 DigestValue E XS08 C 1 Digest Value (Hash SHA-1 Base64)XS18 SignatureValue G XS01 1-1 Grupo do Signature Value

XS19 KeyInfo G XS01 1-1 Grupo do KeyInfo

XS20 X509Data G XS19 1-1 Grupo X509

XS21 X509Certificate E XS20 C 1-1 Certificado Digital x509 em Base64b

2.2.4 Uso de Assinatura com Certificado Digital

Para garantir a autenticidade dos dados gerados, algumas informaes devero ser assinadasdigitalmente. A seguir segue as informaes que devero ser assinadas e quem dever faz-loem cada momento:

O RPSRegistro de Prestao de Servios, pelo contribuinte, antes do envio do mesmoatravs do lote de RPS;

O lote de RPS (apenas as informaes do lote), pelo contribuinte, antes do envio do

mesmo; A NFSE:

o Pela prefeitura e pelo contribuinte, quando gerada pela Aplicao OnLine;o Pela prefeitura nos demais casos;

O pedido de cancelamento da NFSE, pelo contribuinte;

A confirmao de cancelamento da NFSE;
http://www.w3.org/TR/xmldsig-core/http://www.w3.org/2000/09/xmldsig#rhttp://www.w3.org/TR/2001/REC-xml-http://www.w3.org/2000/09/xmldsig#ehttp://www.w3.org/2000/09/xmldsig#shttp://www.w3.org/2000/09/xmldsig#shttp://www.w3.org/2000/09/xmldsig#ehttp://www.w3.org/TR/2001/REC-xml-http://www.w3.org/2000/09/xmldsig#rhttp://www.w3.org/TR/xmldsig-core/


13/26

2.3 - PADRO DAS MENSAGENS XML

A especificao adotada para as mensagens XML a recomendao W3C para XML1.0, disponvel em HTTP://www.w3.org/TR/REC-xml e a codificao dos caracteres ser emUTF-8.

As chamadas dos Web Services disponibilizados pela Secretaria Municipal da Fazenda e osrespectivos resultados do processamento so realizadas atravs das mensagens com oseguinte padro:

rea de Cabealho estrutura XML padro para todas as mensagens de chamadae retorno de resultado dos Web Services disponibilizados pela Secretaria Municipal daFazenda, que contm os dados de controle da mensagem. A rea de cabealho estsendo utilizada para armazenar a verso do leiaute da estrutura XML informado na reade dados

rea de Dados estrutura XML varivel definida na documentao do WebService acessado.

2.3.1 rea do Cabealho

A seguir, o leiaute da rea de Cabealho padro:

# Nome Elemento Pai Tipo Ocorrncia Tamanho Descrio1

cabecalho

G

1-1

TAG raiz do cabealho damensagem.

Verso

A

1

N

1-1

4

Verso do leiaute.

2

versaoDados

E

1

N

1-1

4

O contedo deste campo indica averso do leiaute XML da estruturaXML informada na rea de dados damensagem.

O campo versaoDados deve conter a informao da verso do leiaute da estrutura XMLarmazenada na rea de dados da mensagem.

A estrutura XML armazenada na rea de dados est definida na documentao do WebService acessado.

2.3.2 Validao da estrutura das Mensagens XML

Para garantir minimamente a integridade das informaes prestadas e acorreta formao das mensagens XML, o contribuinte dever submetercada uma das mensagens XML de pedido de servio para validao peloarquivo XSD (XML Schema Definition, definio de esquemas XML) antes deseu envio. Neste manual utilizaremos a nomenclatura Schema XML paranos referir a arquivo XSD.Qualquer divergncia da estrutura da mensagem XML em relao aoSchema XML, provoca um erro de validao do Schema XML. Neste casoo contedo da mensagem XML de pedido do servio no poder ser

processado.A primeira condio para que a mensagem XML seja validada com sucesso que ela seja submetida ao Schema XML em vigor

Assim, os sistemas de informao dos contribuintes devem estar preparados para gerarmensagens XML em Schema XML em vigor.

2.3.3 Schema XML (arquivos XSD)

O Schema XML (arquivo XSD) pode ser obtido na internet acessando o Portal da Nota PortoAlegre.
http://www.w3.org/TR/REC-xmlhttp://www.w3.org/TR/REC-xml


14/26

2.3.4 Verso dos Schema XML

Toda mudana de layout das mensagens XML do Web Service implica na atualizao doSchema XML.

A identificao da verso do Schema XML ser realizada com o acrscimo do nmero daverso com dois dgitos no nome do arquivo XSD precedida da literal _v, como segue:

_v.xsd

Exemplo: SCHEMA_v01.xsd


15/26

3 ESTRUTURA DE DADOS DO WEB SERVICE

Existir um nico Web Service com todos os servios apresentados no item 2. O fluxo decomunicao sempre iniciado pelo sistema do contribuinte atravs do envio de umamensagem XML ao Web Service com o pedido do servio desejado.

3.1 - MODELO OPERACIONAL

As solicitaes de servios que exigem processamento intenso sero executadas de formaassncrona e as demais solicitaes de servios de forma sncrona.

Assim, os servios da NFSE sero implementados da seguinte forma:

Servio

Implementao

Recepo e Processamento de Lote de RPS AssncronaGerao de NFSE Sncrona

Consulta de Situao de Lote de RPS

Sncrona

Consulta de NFSE por RPS SncronaConsulta de Lote de RPS Sncrona

Consulta de NFSE SncronaCancelamento de NFSE

Sncrona

Consulta de NFSE por faixa Sncrona

3.2 - FORMATOS E PADRES UTILIZADOS

A seguir segue algumas formataes de dados que devem ser seguidas para gerao correta

na estrutura dos arquivos.

Formato

Observao

Data (date) Formato: AAAA-MM-DDonde:AAAA = ano com 4 caracteresMM = ms com 2 caracteresDD =dia com 2caracteres

Data/Hora (datetime) Formato AAAA-MM-DDTHH:mm:ssonde:AAAA = ano com 4 caracteresMM = ms com 2 caracteresDD =dia com 2caracteresT = caractere de formatao que deve existir separando a data da horaHH = hora com 2 caracteresmm: minutocom 2 caracteresss: segundocom 2 caracteres

Valores Decimais(decimal)

Formato: 0.00No deve ser utilizado separador de milhar. O ponto(.)deve serutilizado para separar a parte inteira da fracionria.Exemplo:48.562,25 = 48562.251,00 = 1.00 ou 10,50 = 0.50 ou 0.5

Valores Percentuais(decimal)

Formato 0.0000O formato em percentual presume o valor percentual em sua formafracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira dafracionria.Exemplo:62% = 0.62150% = 1.525,32 =0.2532


16/26

No deve ser inserido caractere no significativo para preencher o tamanho completo docampo, ou seja, zeros antes de nmero ou espao em branco aps cadeia de caracteres. Aposio do campo definida na estrutura do documento XML atravs de TAGs(contedo).

A regra constante do pargrafo anterior dever estender-se para os campos onde no h

indicao de obrigatoriedade e que, no entanto, seu preenchimento torna-se obrigatrio porestar condicionado legislao especfica ou ao negcio do contribuinte. Neste caso, deverconstar a TAG com o valor correspondente e, para os demais campos, devero ser eliminadasas TAGs.

Para reduzir o tamanho final do arquivo XML da NFSE alguns cuidados de programao deveroser assumidos:

no incluir "zeros no significativos" para campos numricos; no incluir "espaos" no incio ou no final de campos numricos e alfanumricos; no incluir comentrios no arquivo XML; no incluir anotao e documentao no arquivo XML (TAG annotation e TAG

documentation); no incluir caracteres de formatao no arquivo XML ("line-feed", "carriage return",

"tab", caractere de "espao" entre as TAGs).

As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser enviada.

3.3 - TIPOS SIMPLES

A seguir encontra-se a tabela com a lista dos tipos simples que sero utilizados como tipos dedados. A tabela est dividida em 4 colunas, a saber:

Campo: nome do tipo simples; Tipo: tipo primitivo de dados utilizados pelo campo:

o C: Caractere;o N: Nmero;o D: Data ou Data/Hora;o T: Token;

Descrio: descreve informaes sobre o campo; Tam.: tamanho do campo:

o Quando for caracteres o tamanho define a quantidade mxima de caracteres que otexto poder ter;

o Quando for numrico o tamanho pode ser representado das seguintes formas Nmero inteiro, que define o total de dgitos existente no nmero.

Exemplo: 15significa que o nmero poder ter, no mximo, 15 dgitos; Nmero fracionrio, que define o total de dgitos e quantos deles sero

designados para a parte fracionria. Exemplo: 15,2 significa que o nmero poder ter, no mximo, 15 dgitos

sendo 2 deles a identificao da parte fracionria. A parte fracionria no obrigatria quando assim definido;

o Quando for data, no haver definio de tamanho.


17/26

Campo Tipo Descrio Tam.TsNumeroNfse N Nmero da Nota Fiscal de Servio Eletrnica,

formado pelo ano com04(quatro) dgitos e umnmero seqencial com 11 posies FormatoAAAANNNNNNNNNNN.

15

tsCodigoVerificacao C Cdigo de verificao do nmero da nota 9

TsStatusRps

N

Cdigo de status do RPS1 Normal2 Cancelado

1

TsStatusNfse

N

Cdigo de status da NFSE1 Normal2 Cancelado

1

tsNaturezaOperacao N Cdigo de natureza da operao1 Tributao no municpio2 - Tributao fora do municpio3 - Iseno4 - Imune5 Exigibilidade suspensa por deciso judicial6 Exigibilidade suspensa por procedimento

administrativo

2

tsRegimeEspecialTributacao N Cdigo de identificao do regime especial detributao1 Microempresa municipal2 - Estimativa3 Sociedade de profissionais

4

Cooperativa5 MEI Simples Nacional6 ME EPP Simples Nacional

2

TsSimNao N Identificao de Sim/No1 - Sim2 No

1

TsQuantidadeRps N Quantidade de RPS do Lote 4TsNumeroRps N Nmero do RPS 15TsSerieRps C Nmero de srie do RPS 5

TsTipoRps N Cdigo de tipo de RPS1 - RPS2 Nota Fiscal Conjugada (Mista)3 Cupom

1

tsOutrasInformacoes C Informaes adicionais aodocumento. 255

TsValor N Valor monetrio.Formato: 0.00 (ponto separando casa decimal)Ex: 1.234,56 = 1234.56

1.000,00 = 1000.001.000,00 = 1000

15,2

tsItemListaServico C Cdigo de item da lista de servio 5

TsCodigoCnae N Cdigo CNAE 7tsCodigoTributacao C Cdigo de Tributao 20

TsAliquota N Alquota. Valor percentual.Formato: 0.0000Ex: 1% = 0.01

25,5% = 0.255100% = 1.0000 ou 1

5,4

tsDiscriminacao C Discriminao do contedo da NFSE 2000

tsCodigoMunicipioIbge N Cdigo de identificao domunicpioconformetabela do IBGE

7

tsIncricaoMunicipal C Nmero de inscrio municipal 15

tsRazaoSocial C Razo Social do contribuinte 115

tsNomeFantasia C Nome fantasia 60

TsCnpj

C

Nmero CNPJ

14tsEndereco C Endereo 125

tsNumeroEndereco C Nmero do endereo 10

tsComplementoEndereco C Complemento de endereo 60

tsBairro C Bairro 60


18/26

tsUf C Sigla da unidade federativa 2

tsCep N Nmero do CEP 8

tsEmail C E-mail 80tsTelefone C Telefone 11

TsCpf C Nmero de CPF 11tsIndicacaoCpfCnpj N Indicador de uso de CPF ou CNPJ

1 CPF2 CNPJ3 No Informado

1

tsCodigoObra

C

Cdigo de Obra

15

tsArt C Cdigo ART 15tsNumeroLote N Nmero do Lote de RPS 15

TsNumeroProtocolo C Nmero do protocolo de recebimento do RPS 50

tsSituacaoLoteRps N Cdigo de situao de lote de RPS1 No Recebido2 No Processado3 Processado com Erro4 Processado com Sucesso

1

tsCodigoMensagemAlerta C Cdigo de mensagem de retorno de servio. 4TsDescricaoMensagemAlerta C Descrio da mensagem de retornodeservio. 200

TsCodigoCancelamentoNfse C Cdigo de cancelamento com base na tabela deErros e alertas.

4

tsIdTag C Atributo de identificao da tag a serassinada no documento XML

255

tsPagina N Nmero da pgina da consulta 6

Observao importante: Em Porto Alegre ser aceito somente RPS com Status doRPS (TsStatusRps) igual a 1Normal

3.4 - TIPOS COMPLEXOS

A seguir sero detalhadas as tabelas de cada tipo composto e seus campos. A tabelaest dividida da seguinte forma:

(1)

(2)Nome

Tipo OcorrnciaDescrio

(3)

(4) (5) (6) (7)

(4) (5) (6) (7)

1. Nome do tipo complexo;2. Descrio do tipo complexo;3. Identifica se a seqncia de campos far parte de uma escolha (Choice);4. Nome do campo que faz parte do tipo complexo;5. Tipo do campo, que pode ser de um tipo simples ou complexo;6. Quantas vezes o campo se repete na estrutura de dados:

a. Formato: x-y onde x a quantidade mnima e y a quantidade mxima. Se aquantidade mxima for indefinida, ser utilizado Nno lugar do y;

7. Descrio do campo.

TcCpfCnpjNmero de CPF ou CNPJ

Nome Tipo OcorrnciaDescrio

ChoiceCpf tsCpf 1-1 Nmero do Cpf

Cnpj tsCnpj 1-1 Nmero do Cnpj

TcEnderecoRepresentao completa do endereoNome Tipo OcorrnciaDescrio

Endereco tsEndereco 1-1 EndereoNumero tsNumeroEndereco 1-1 Nmero do endereo


19/26

Complemento tsComplementoEndereco 0-1 Complemento do Endereo

Bairro tsBairro 1-1 Nome do bairro

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Cdigo da cidadeUf tsUf 1-1 Sigla do estado

Cep tsCep 1-1 CEP da localidade

TcContato

Representa forma de contato com a pessoa (fsica/jurdica)

Nome

Tipo

Ocorrncia

DescrioTelefone tsTelefone 0-1

Email tsEmail 0-1

tcIdentificacaoOrgaoGerador

Representa dados para identificao de rgo gerador


CodigoMunicipio tsCodigoMunicipioIbge 1-1

Uf tsUf 1-1

tcIdentificacaoRpsDados de identificao do RPS


Numero

tsNumeroRps

1-1

Serie

tsSerieRps

1-1

Tipo

tsTipoRps

1-1

tcIdentificacaoPrestador Representa dados para identificao do prestador de servioNome Tipo OcorrnciaDescrio

Cnpj tsCnpj 1-1

InscricaoMunicipal tsInscricaoMunicipal 1-1

tcIdentificacaoTomadorRepresenta dados para identificao do tomador de servio

Nome


CpfCnpj tcCpfCnpj 0-1

InscricaoMunicipal tsInscricaoMunicipal 0-1

tcDadosTomador Representa dados do tomador de servio


IdentificacaoTomador TcIdentificacaoTomador 0-1

RazaoSocial TsRazaoSocial 1-1Endereco TcEndereco 1-1

Contato TcContato 0-1

TcIdentificacaoIntermediarioServicoRepresenta dados para identificao de intermedirio do servio


RazaoSocial tsRazaoSocial 1-1

CpfCnpj tcCpfCnpj 1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

TcValoresRepresenta um conjunto de valores que compe o documento fiscal


ValorServicos tsValor 1-1

ValorDeducoes tsValor 0-1

ValorPis tsValor 0-1ValorCofins tsValor 0-1

ValorInss tsValor 0-1

ValorIr tsValor 0-1


20/26

ValorCsll tsValor 0-1

IssRetido tsSimNao 1-1

ValorIss tsValor 0-1OutrasRetencoes tsValor 0-1

BaseCalculo tsValor 0-1 (Valor dos servios - Valordas dedues - descontosincondicionados)

Aliquota tsAliquota 0-1

ValorLiquidoNfse tsValor 0-1 (ValorServicos - ValorPIS-ValorCOFINS - ValorINSSValorIR ValorCSLL-OutrasRetenoes -ValorISSRetido -DescontoIncondicionado DescontoCondicionado)

ValorIssRetido tsValor 0-1

DescontoCondicionado tsValor 0-1

DescontoIncondicionado tsValor 0-1

TcDadosServico

Representa dados que compe o servio prestado


Valores tcValores 1-1ItemListaServico tsItemListaServico 1-1

CodigoCnae

tsCodigoCnae

0-1

CodigoTributacaoMunicipio

tsCodigoTributacao

1-1

Discriminacao tsDiscriminacao 1-1

CodigoMunicipio tsCodigoMunicipioIbge 1-1

tcDadosConstrucaoCivilRepresenta dados para identificao de construo civil


CodigoObra tsCodigoObra 1-1Art tsArt 1-1

tcDadosPrestadorRepresenta dados do prestador do servio


IdentificacaoPrestador tcIdentificacaoPrestador 1-1

RazaoSocial

tsRazaoSocial

1-1NomeFantasia tsNomeFantasia 0-1

Endereco tcEndereco 1-1

Contato tcContato 0-1

TcInfRps

Representa dados informativos do Recibo Provisrio de Servio (RPS)


Id tsIdTag Identificador da TAGa ser assinada

IdentificacaoRps TcIdentificacaoRps 1-1

DataEmissao Datetime 1-1 Transforma-se emCompetencia no TcInfNfse

NaturezaOperacao TsNaturezaOperacao 1-1

RegimeEspecialTributacao TsRegimeEspecialTributacao 0-1

OptanteSimplesNacional

TsSimNao

1-1IncentivadorCultural TsSimNao 1-1

Status TsStatusRps 1-1

RpsSubstituido TcIdentificacaoRps 0-1

Servico TcDadosServico 1-1Prestador TcIdentificacaoPrestador 1-1

Tomador TcDadosTomador 1-1IntermediarioServico tcIdentificacaoIntermediarioServico 0-1

ConstrucaoCivil TcDadosConstrucaoCivil 0-1


21/26

TcRpsRepresenta a estrutura do Registro de Prestao de Servio (RPS) assinadoNome Tipo OcorrnciaDescrio

InfRps tcInfRps 1-1

Signature dsig:Signature 0-1

tcIdentificacaoNfse Representa dados que identificam uma Nota Fiscal de Servios Eletrnica

Nome

Tipo

Ocorrncia

Descrio

Numero tsNumeroNfse 1-1

Cnpj tsCnpj 1-1InscricaoMunicipal tsInscricaoMunicipal 0-1

CodigoMunicipio

tsCodigoMunicipioIbge

1-1

TcInfNfseRepresenta os dados informativos da Nota Fiscal de Servios Eletrnica



Numero tsNumeroNfse 1-1

CodigoVerificacao tsCodigoVerificacao 1-1DataEmissao Datetime 1-1

IdentificacaoRps tcIdentificacaoRps 0-1

DataEmissaoRps

Date

0-1NaturezaOperacao tsNaturezaOperacao 1-1

RegimeEspecialTributacao tsRegimeEspecialTributacao 0-1OptanteSimplesNacional TsSimNao 1-1

IncetivadorCultural

TsSimNao

1-1

Competencia Datetime 1-1

NfseSubstituida tsNumeroNfse 0-1

OutrasInformacoes tsOutrasInformacoes 0-1

Servico tcDadosServico 1-1ValorCredito TsValor 0-1

PrestadorServico tcDadosPrestador 1-1

TomadorServico tcDadosTomador 1-1

IntermediarioServico tcIdentificacaoIntermediarioServico 0-1

OrgaoGerador tcIdentificacaoOrgaoGerador 1-1

ConstrucaoCivil tcDadosContrucaoCivil 0-1

TcNfse

Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada

Nome Tipo Ocorrncia Descrio

InfNfse tcInfNfse 1-1

Signature Dsig:Signature 1-2

tcInfPedidoCancelamentoRepresenta a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelaruma

Nome Tipo Ocorrncia Observao

Id tsIdTag Identificador da TAG a serassinada

IdentificacaoNfse tcIdentificacaoNfse 1-1

CodigoCancelamento tsCodigoCancelamentoNfse 1-1

TcPedidoCancelamentoRepresenta a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinadaNome Tipo Ocorrncia Descrio

InfPedidoCancelamento tcInfPedidoCancelamento 1-1

Signature Dsig:Signature 0-1

tcLoteRps3Nome Tipo OcorrnciaObservao

Id tsIdTag Identificador da TAG a serassinada


22/26

NumeroLote TsNumeroLote 1-1

Cnpj TsCnpj 1-1

InscricaoMunicipal TsInscricaoMunicipal 1-1QuantidadeRps TsQuantidadeRps 1-1

ListaRps 1-1Rps TcRps 1-3

TcConfirmacaoCancelamento

Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinadaNome Tipo Ocorrncia Descrio


Pedido TcPedidoCancelamento 1-1DataHora datetime 1-1

TcCancelamentoNfse Representa a estrutura completa (pedido + confirmao) de cancelamento de NFSE.Nome Tipo Ocorrncia Descrio

Confirmacao TcConfirmacaoCancelamento 1-1Signature Dsig:Signature 1-1

TcInfSubstituicaoNfse

Representa os dados de registro de substituio de NFSE.

Nome

Tipo

Ocorrncia

Descrio

Id

tsIdTag Identificador da TAG a ser

assinadaNfseSubstituidora tsNumeroNfse 1-1

TcSubstituicaoNfse

Representa a estrutura de substituio de NFSE.

Nome


SubstituicaoNfse tcInfSubstituicaoNfse 1-1

Signature dsig:Signature 1-2

TcCompNfseRepresenta a estrutura de compartilhamento de dados de uma NFSE.

Nome


Nfse

tcNfse

1-1

NfseCancelamento

tcCancelamentoNfse

0-1

NfseSubstituicao tcSubstituicaoNfse 0-1

tcMensagemRetorno Representa a estrutura de mensagem de retorno de servio.


Codigo TsCodigoMensagemAlerta 1-1

Mensagem tsDescricaoMensagemAlerta 1-1

Correcao tsDescricaoMensagemAlerta 0-1

ListaMensagemRetorno

Representa a estrutura de mensagem de retorno de servio.


MensagemRetorno tcMensagemRetorno 1- N

tcMensagemRetornoLoteRepresenta a estrutura de mensagem de retorno de servio.


IdentificacaoRps TcIdentificacaoRps 1-1Codigo TsCodigoMensagemAlerta 1-1

Mensagem tsDescricaoMensagemAlerta 1-1


23/26

tcLoteRps

Nome Tipo OcorrnciaObservao

Id tsIdTag Identificador da TAG a serNumeroLote TsNumeroLote 1-1Cnpj TsCnpj 1-1InscricaoMunicipal TsInscricaoMunicipal 1-1QuantidadeRps TsQuantidadeRps 1-1ListaRps 1-1Rps TcRps 1-N

3.5 - SERVIOS

A seguir esto os servios disponveis, conforme descritos no item 2, no WebServicee seu XML Schema. O XML Schema define a estrutura e formatao do arquivo XML queconter os dados a serem trafegados. Esses documentos sero enviados de forma textual(como uma string) como parmetros do servio oferecido pelo Web Service, como descrito em2.2.1.

As tabelas que detalham cada XML Schema esto divididas da seguinte forma:

(1)

# Nome Tipo Pai Ocorrncia Observao

(2

(3)

(4)

(5)

(6)

(7)

(8)(9)

1. Nome do arquivo XSD;2. Nmero identificador do campo, quando este contiver subitens;3. Nome do campo;4. Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo;5. Indica quem o campo pai, para definio da hierarquia;6. Quantas vezes o campo se repete na estrutura de dados:

a. Formato: z-y onde x a quantidade mnima e y a quantidade mxima. Se aquantidade mxima for indefinida, ser utilizado Nno lugar do y;

7. Descreve alguma observao pertinente;8. Formato de grupo, utilizado para definio de uma escolha (ver prximo item);9. Identifica os campos ou grupos que faro parte de uma escolha (Choice).

3.5.1 - Recepo de Lote de RPS

Esse servio ser executado, inicialmente, atravs da chamada ao mtodoRecepcionarLoteRps, passando a mensagem XML como parmetro com a estrutura definidana tabela que segue.

nfse.xsd# Nome Tipo Pai OcorrnciaObservao

1 EnviarLoteRpsEnvio 1-1

LoteRps TcLoteRps 1 1-1

Signature dsig:Signature 1 0-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.

nfse.xsd

#

Nome

Tipo

Pai OcorrnciaObservao

1 EnviarLoteRpsResposta 1-1

NumeroLote tsNumeroLote 1

DataRecebimento Datetime 1

Protocolo tsNumeroProtocolo 1

2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1


24/26

O lote ser processado posteriormente, sendo o seu resultado disponibilizado para consulta.

3.5.2 - Gerao de NFSE

Esse servio ser executado, inicialmente, atravs da chamada ao mtodo GerarNfse,passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.

nfse.xsd

# Nome Tipo Pai OcorrnciaObservao

1 GerarNfseEnvio 1-1

LoteRps TcLoteRps3 1 1-1

Signature dsig:Signature 1 0-1


nfse.xsd

#

Nome

Tipo

Pai Ocorrnci

Observao

1 GerarNfseResposta 1-1

NumeroLote TsNumeroLote 1 0-1

DataRecebimento

Datetime

1

0-1

Protocolo

tsNumeroProtocolo

1

0-1

2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1Choice3 ListaMensagemRetornoLote ListaMensagemRetornoLote 1 1-1

4 ListaNfse 1 1-11-NCompNfse tcCompNfse 4

3.5.3 - Consulta de Situao de Lote de RPS.

Esse servio ser executado atravs da chamada ao mtodoConsultarSituacaoLoteRps, passando a mensagem XML como parmetro com a estruturadefinida na tabela que segue.

nfse.xsd

#

Nome

Tipo

Pai

Ocorrncia

Observao1 ConsultarSituacaoLoteRpsEn 1-1

Prestador TcIdentificacaoPrestador 1 1-1

Protocolo TsNumeroProtocolo 1 1-1


nfse.xsd

#

Nome

Tipo


1 ConsultarSituacaoLoteRpsResposta

1-1

NumeroLote tsNumeroLote 11-1

ChoiceSituao tsSituacaoLoteRps 1



25/26

3.5.4 - Consulta de NFSE por RPS

Esse servio ser executado atravs da chamada ao mtodo ConsultarNfsePorRps, passandoa mensagem XML como parmetro com a estrutura definida na tabela que segue.

nfse.xsd


1 ConsultarNfseRpsEnvio

IdentificacaoRps

tcIdentificacaoRps

1

1-1

Prestador

tcIdentificacaoPrestador

1

1-1


nfse.xsd# Nome Tipo Pai OcorrnciaObservao

1 ConsultarNfseRpsRespostaCompNfse tcCompNfse 1 1-1

Choice


3.5.5 - Consulta de NFSE

Esse servio ser executado atravs da chamada ao mtodo ConsultarNfse, passando amensagem XML como parmetro com a estrutura definida na tabela que segue.

nfse.xsd

# Nome Tipo Pai Ocorrncia Observao

1 ConsultarNfseEnvio 1-1Prestador tcIdentificacaoPrestador 1 1-1

NumeroNfse tsNumeroNfse 1 0-1

2 PeriodoEmissao 1 0-1

DataInicial date 2 1-1

DataFinal

date

2

1-1

Tomador tcIdentificacaoTomador 1 0-1

IntermediarioServico TcIdentificacaoIntermediarioServico 1 0-1


nfse.xsd# Nome Tipo Pai OcorrnciaObservao1 ConsultarNfseResposta 1-1

2 ListaNfse 1 1-1ChoiceCompNfse

tcCompNfse

2

0 - N3 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

3.5.6 - Consulta de Lote de RPS

Esse servio ser executado atravs da chamada ao mtodo ConsultarLoteRps, passandoa mensagem XML como parmetro com a estrutura definida na tabela que segue.

nfse.xsd


1 ConsultarLoteRpsEnvio 1-1Prestador TcIdentificacaoPrestador 1 1-1

Protocolo TsNumeroProtocolo 1 1-1


26/26


nfse.xsd


1 ConsultarLoteRpsResposta 1-1

2

ListaNfse

1

1-1 ChoiceCompNfse tcCompNfse 2 1-N


3.5.7 - Cancelamento NFSE

Esse servio ser executado atravs da chamada ao mtodo CancelarNfse, passando amensagem XML como parmetro com a estrutura definida na tabela que segue.

nfse.xsd


1 CancelarNfseEnvio 1-1

Pedido TcPedidoCancelamento 1 1-1


nfse.xsd#

Nome

Tipo


1 CancelarNfseResposta

Cancelamento TcCancelamentoNfse 1 1-1Choice


3.5.8 Consulta de NFSE por faixa

Esse servio ser executado pelo mtodo ConsultarNfseFaixa, passando a mensagem XML comoparmetro com a estrutura definida na tabela que segue.

nfse.xsd

# Nome Tipo PaiOcorrncia Observao

1 ConsultarNfseFaixaEnvio 1-1

Prestador tcIdentificacaoPrestador 1 1-1

2 Faixa 1 0-1

NumeroNfseInicial tsNumeroNfse 2 1-1

NumeroNfseFinal tsNumeroNfse 2 1-1

3 Pagina tsPagina 1 1-1


nfse.xsd

# Nome Tipo PaiOcorrncia Observao

1 ConsultarNfseFaixaResposta 1-1

2 ListaNfse 1 1-1

ChoiceCompNfse CompNfse 2 1 - 50

Documents

anexo_v_-_nfse_termo_de_referencia_tecnico_-_versao_20_08_2015