Sie sind auf Seite 1von 26

ANEXO V TERMO 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 de
Servios, anexa Lei Complementar n116/03, acrescida daqueles que foram vetados e de um item
9999 para outros servios.
O sistema permite a descrio de vrios servios numa mesma NFSE, desde que relacionados a
um nico item da Lista, de mesma alquota e para o mesmo tomador de servio. Quando a
legislao do municpio assim exigir, no caso da atividade de construo civil, as NFSE devero ser
emitidas 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 fiscais
para pessoa jurdica, exceto quando se tratar de tomador do exterior.
A competncia de uma NFSE o ms da ocorrncia do fato gerador. O sistema assumir
automaticamente o ms/ano da emisso do RPS - Registro de Prestao de Servio ou da NFSE, o
que 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 <DataEmissao> do RPS a data da prestao do servio. Quando a Prefeitura
gerar a NFSE, assumir como data da competncia a data informada no RPS (veja a estrutura de
dados TcInfRps)
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 desconto
condicionado.
A base de clculo da NFSE o valor total de servios, subtrado do valor de dedues previstas em
lei e do desconto incondicionado.
O valor do ISSQN definido de acordo com a natureza da operao, a opo pelo simples
nacional, o regime especial de tributao e o ISS retido, e ser sempre calculado, exceto nos
seguintes casos:
o

A natureza da operao for tributao no municpio; exigibilidade suspensa por deciso


judicial ou exigibilidade suspensa por procedimento administrativo e o regime especial de
tributao for estimativa, sociedade de profissionais ou MEI do simples nacional.

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

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

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

A alquota do ISSQN definida pela legislao municipal.

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 gerao
da NFSE s poder ser feito em lotes, ou seja, vrios RPS agrupados para gerar uma NFSE
para cada um deles.
Com base nessa circunstncia, o servio de recepo de lote de RPS ser definido como
Assncrono.
Como comprovante de envio de lote de RPS, o contribuinte receber apenas um nmero de
protocolo de recebimento. O lote recebido pela Secretaria da Fazenda ser colocado em uma
fila 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- e
correspondentes ou a lista de erro(s) encontrado(s) no lote.
A numerao dos lotes de RPS de responsabilidade do contribuinte, devendo ser nica e
distinta 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 Conceitual
definido pela ABRASF.
Legenda
INFORMACAO IDENTIFICACAO DA INFORMACAO
OC
Descricao
Ob
Tip

Ocorrncia

Tam

Tamanho

Nmero de vezes que a informao pode ser apresentada.


Breve descrio a respeito da identificao da informao.
Obrigatoriedade de preenchimento
N numrico
C caracteres
D Data/ Hora
Quantidade mxima de caracteres ou preciso numrica, dependendo do tipo
de informao.

Obrigatrio
Tipo

1.2.1.1 - NOTA FISCAL DE SERVIOS ELETRNICA


INFORMACAO
IDENTIFICACAO DA NFSE

OC. DESCRICAO

CONSOL.
Ob Tip Tam

Assinatura
NumeroNFSe

1-1
1-1

S
S

Item 2.2.3
N
15

CdigoVerificacao
DataEmissaoNFSe
Competencia
NumeroNFSeSubstituda
NaturezadaOperacao

1-1
1-1
1-1
0-1
1-1

S
S
S
N
S

C
D
N
N
N

9
0
6
15
2

RegimeEspecialTributacao

0-1

OptanteSimplesNacional
IncentivadorCultural
NumeroRPS

1-1
1-1
0-1

S
S
N

N
N
N

1
1
15

SerieRPS
TipoRPS

0-1
0-1

C
N

5
1

DataEmissaoRPS

0-1

Nmero do equipamento emissor do RPS ou srie do RPS.


N
1 Registro de Prestao de Servios; 2 Nota Fiscal
N
Conjugada (Mista); 3 Cupom. Campo Obrigatrio apenas para
NFSE geradas pela emisso de RPS.
Data da emisso do RPS (AAAA-MM-DD). Campo Obrigatrio
N
apenas para NFSE geradas pela emisso de RPS.

Outrasinformacoes

0-1

Uso da administrao fazendria

255

Assinatura digital
Nmero da NFSE, formado pelo ano com 04 (quatro) dgitos e
um nmero sequencial com 11 posies Formato
AAAANNNNNNNNNNN.
Cdigo da Verificao da NFSE
Data/Hora da emisso da NFSE (AAAA-MM-DDTHH:mm:ss).
Ms e ano da prestao de servio. (AAAAMM).
Nmero da NFSE substituda.
1 Tributao no municpio; 2 Tributao fora do municpio;
3 Iseno; 4 Imune; 5 Exigibilidade suspensa por
deciso judicial; 6 Exigibilidade suspensa por procedimento
administrativo.
1 Microempresa Municipal; 2 Estimativa; 3 Sociedade
de Profissionais; 4 Cooperativa; 5 MEI Simples Nacional;
6 ME EPP Simples Nacional.
1 Sim; 2 No
1 Sim; 2 No
Nmero do RPS. Campo Obrigatrio apenas para NFSE
geradas pela emisso de RPS.

IDENTIFICACAO DA PRESTACAO DO SERVICO

Ob Tip Tam

ValorServicos
ValorDeducoes
ValorPIS
ValorCOFINS
ValorINSS
ValorIR
ValorCSLL
ItemListaServico
CodigoCNAE
CodigoTributacaoMunicpio
BaseCalculo

1-1
0-1
0-1
0-1
0-1
0-1
0-1
1-1
0-1
1-1
0-1

S
N
N
N
N
N
N
S
N
S
N

N
N
N
N
N
N
N
C
C
C
N

15,2
15,2
15,2
15,2
15,2
15,2
15,2
5
7
20
15,2

AlquotaServicos
ValorISS
ValorLquidoNFSe

0-1
0-1
0-1

N
N
N

N
N
N

5,4
15,2
15,2

OutrasRetencoes
ValorCredito
ISSRetido
ValorISSRetido
ValorDescontoIncondicionado
ValorDescontoCondicionado
Discriminacao
MunicipioPrestacaoServico

0-1
0-1
1-1
0-1
0-1
0-1
1-1
1-1

N
N
S
N
N
N
S
S

N
N
N
N
N
N
C
N

15,2
15,2
1
15,2
15,2
15,2
2000
7

Valor dos servios em R$.


Valor das dedues para Reduo da Base de Clculo em R$.
Valor da reteno do PIS em R$. Informao declaratria.
Valor da reteno do COFINS em R$. Informao declaratria.
Valor da reteno do INSS em R$. Informao declaratria.
Valor da reteno do IR em R$. Informao declaratria.
Valor da reteno do CSLL em R$. Informao declaratria.
Cdigo do servio prestado. Item da LC 116/2003
CNAE 2.0
Cdigo do servio prestado prprio do municpio
(Valor dos servios - Valor das dedues descontos
incondicionados)
Alquota do servio prestado.
Valor do ISS em R$.
(ValorServicos - ValorPIS - ValorCOFINS - ValorINSS
ValorIR - ValorCSLL - OutrasRetenoes - ValorISSRetido DescontoIncondicionado - Descont oCondicionado)
Outras retenes na Fonte. Informao Declaratria
Valor do crdito gerado.
1 - Sim 2 No
Valor do ISS a ser retido.

Discriminao dos servios.


Cdigo do municpio onde o servio foi prestado (tabela
do IBGE), se exterior colocar 9999999

IDENTIFICACAO DO PRESTADOR DO SERVICO


InscricaoPrestador
RazaoSocialPrestador
NomeFantasiaPrestador
CNPJPrestador
EndereoPrestador
NumeroEnderecoPrestador
ComplementoEndereoPrestador
BairroPrestador
CidadePrestador

1-1
1-1
0-1
1-1
1-1
1-1
0-1
1-1
1-1

UFPrestador
CepPrestador
EmailPrestador
TelefonePrestador

1-1
1-1
0-1
0-1

Ob Tip Tam

Inscrio municipal do prestador que emitiu a NFSE


S
Razo Social do prestador do servio
S
Nome Fantasia do prestador do servio
N
Nmero do CNPJ do prestador do servio
S
Tipo e nome do logradouro (Av.., Rua..., ...)
S
Nmero do imvel
S
Complemento do endereo do prestador
N
Bairro do prestador
S
Cdigo do municpio do estabelecimento prestador do servio S
(Tabela do IBGE)
Sigla da unidade da federao do prestador
S
Nmero do CEP
S
E-mail do prestador
N
Nmero do telefone do prestador
N

C
C
C
C
C
C
C
C
N

15
115
60
14
125
10
60
60
7

C
N
C
C

2
8
80
11

IDENTIFICACAO DO TOMADOR DO SERVICO

Ob Tip Tam

CPFCNPJTomador
IndicacaoCPFCNPJ
InscricaoMunicipalTomador

0-1
0-1
0-1

N
N
N

C
N
C

14
1
15

RazaoSocialTomador
EnderecoTomador
NumeroEnderecoTomador
ComplementoEnderecoTomador
BairroTomador
CidadeTomador

1-1
1-1
1-1
0-1
1-1
1-1

S
S
S
N
S
S

C
C
C
C
C
N

115
125
10
60
60
7

UFTomador
CepTomador
EmailTomador
TelefoneTomador

1-1
1-1
0-1
0-1

S
S
N
N

C
N
C
C

2
8
80
11

CPF/CNPJ do tomador do servio. Obrigatrio para CNPJ


1 - CPF 2 - CNPJ 3 - No Informado
Este elemento s dever ser preenchido para tomadores
cadastrados no municpio.
Nome / Razo Social do tomador.
Tipo e nome do logradouro (Av.., Rua..., ...)
Nmero do Imvel
Complemento do Endereo do tomador
Bairro do tomador
Cdigo do municpio onde o tomador est estabelecido (Tabela
do IBGE)
Sigla da unidade da federao do tomador
Nmero do CEP
E-mail do tomador
Nmero do telefone do tomador

IDENTIFICACAO DO INTERMEDIRIO DO SERVIO

Ob Tip

Tam

RazaoSocialIntermediarioServico
InscricaoMunicipalIntermediarioServico

0-1
0-1

Nome ou Razo Social de intermedirio do servio


Nmero da inscrio municipal do intermedirio do servio

N
N

C
C

115
15

CNPJIntermediarioSevico

0-1

Nmero do CNPJ do intermedirio do servio

14

Ob

Tip Tam

S
S

N
C

DETALHAMENTO ESPECIFICO DA CONTRUCAO CIVIL

Ob

Tip Tam

CodigodaObra
ART

N
N

C
C

IDENTIFICACAO DO ORGAO GERADOR


CodigodoMunicipioGerador
UFdoMunicipioGerador

1-1
1-1

0-1
0-1

Cdigo do IBGE
Sigla da unidade da federao do municpio gerador da NFSE

Numero da matricula CEI da obra ou da empresa


Numero da ART

7
2

15
15

1.2.2.2 - REGISTRO DE PRESTAO DE SERVIOS - RPS


INFORMACO
IDENTIFICACAO DO RPS

OC. DESCRICO

Assinatura
NaturezadaOperacao

1-1
1-1

RegimeEspecialTributacao

0-1

OptanteSimplesNacional
IncentivadorCultural
NumeroRPS
SerieRPS
TipoRPS

1-1
1-1
1-1
1-1
1-1

DataEmissaoRPS
StatusRPS
NumeroRPSSubstituido
SerieRPSSubstituido

1-1
1-1
0-1
0-1

Assinatura digital
1 Tributao no municpio; 2 Tributao fora do municpio;
3 Iseno; 4 Imune; 5 Exigibilidade suspensa por
deciso judicial; 6 - Exigibilidade suspensa por procedimento
administrativo.
1 Microempresa Municipal; 2 Estimativa; 3 Sociedade
de Profissionais; 4 Cooperativa; 5 MEI Simples
Nacional; 6 ME EPP Simples Nacional.
1 Sim; 2 No
1 Sim; 2 No
Nmero do RPS.
Nmero do equipamento emissor do RPS ou srie do RPS.
1 Registro de Prestao de Servios; 2 Nota Fiscal
Conjugada (Mist a); 3 Cupom.
Data da emisso do RPS (AAAA-MM-DD).
1 Normal; 2 Cancelado
Nmero do RPS substitudo
Nmero do equipamento emissor do RPS ou srie do RPS
substitudo.

CONSOL.
Ob Tip

Tam

S
S

Item 2.2.3
N
2

S
S
S
S
S

N
N
N
C
N

1
1
15
5
1

S
S
N
N

D
N
N
C

0
1
15
5

IDENTIFICACAO DA PRESTACAO DO SERVICO


ValorServicos
ValorDeducoes
ValorPIS
ValorCOFINS
ValorINSS
ValorIR
ValorCSLL
ItemListaServico
CodigoCNAE
CodigoTributacaoMunicipio
BaseCalculo

1-1
0-1
0-1
0-1
0-1
0-1
0-1
1-1
0-1
1-1
0-1

AliquotaServicos
ValorISS
ValorLiquidoNFSE

0-1
0-1
0-1

OutrasRetencoes
ISSRetido
ValorISSRetido
ValorDescontoIncondicionado
ValorDescontoCondicionado
Discriminacao
MunicipioPrestacaoServico

0-1
1-1
0-1
0-1
0-1
1-1
1-1

Valor dos servios em R$.


Valor das dedues para Reduo da Base de Clculo em R$.
Valor da reteno do PIS em R$. Informao declaratria.
Valor da reteno do COFINS em R$. Informao declaratria.
Valor da reteno do INSS em R$. Informao declaratria.
Valor da reteno do IR em R$. Informao declaratria.
Valor da reteno do CSLL em R$. Informao declaratria.
Cdigo do servio prestado. Item da LC 116/2003
CNAE 2.0
Cdigo do servio prestado prprio do municpio
(Valor dos servios - Valor das dedues descontos
incondicionados)
Alquota do servio prestado.
Valor do ISS em R$.
(ValorServicos - ValorPIS - ValorCOFINS - ValorINSS ValorIR ValorCSLL - OutrasRet enoes ValorISSRetido Descont oIncondicionado - Descont oCondicionado)
Outras retenes na Fonte. Informao Declaratria
1 - Sim 2 No
Valor do ISS a ser retido.

Discriminao dos servios.


Cdigo do municpio onde o servio foi prestado (tabela do
IBGE), se exterior colocar 9999999

S
N
N
N
N
N
N
S
N
S
N

N
N
N
N
N
N
N
C
C
C
N

15,2
15,2
15,2
15,2
15,2
15,2
15,2
5
7
20
15,2

N
N
N

N
N
N

5,4
15,2
15,2

N
S
N
N
N
S
S

N
N
N
N
N
C
N

15,2
1
15,2
15,2
15,2
2000
7

IDENTIFICACAO DO TOMADOR DO SERVICO


CPFCNPJTomador
IndicacaoCPFCNPJ
InscricaoMunicipalTomador

0-1
1-1
0-1

CPF/CNPJ do tomador do servio. Obrigatrio para CNPJ


1 - CPF 2 - CNPJ 3 - No Informado
Este elemento s dever ser preenchido para tomadores
cadastrados no municpio.

N
S
N

C
N
C

14
1
15

RazaoSocialTomador
EnderecoTomador
NumeroEnderecoTomador
ComplementoEnderecoTomador
BairroTomador
CidadeTomador

1-1
1-1
1-1
0-1
1-1
1-1

Nome / Razo Social do tomador.


Tipo e nome do logradouro (Av.., Rua..., ...)
Nmero do Imvel
Complemento do endereo do tomador
Bairro do tomador
Cdigo do municpio onde o tomador est estabelecido (Tabela
do IBGE)

S
S
S
N
S
S

C
C
C
C
C
N

115
125
10
60
60
7

UFTomador
CepTomador
EmailTomador
TelefoneTomador

1-1
1-1
0-1
0-1

Sigla da unidade da federao do tomador


Nmero do CEP
E-mail do tomador
Nmero do telefone do tomador

S
S
N
N

C
N
C
C

2
8
80
11

IDENTIFICACO DO INTERMEDIRIO DO SERVIO


RazaoSocialIntermediarioServico
InscricaoMunicipalIntermediarioServico

0-1
0-1

Nome ou Razo Social de intermedirio do servio


Nmero da inscrio municipal do intermedirio do servio

N
N

C
C

115
15

CNPJIntermediarioServico

0-1

Nmero do CNPJ do intermedirio do servio

14

S
S

C
C

15
14

N
N

C
C

15
15

IDENTIFICACAO DO PRESTADOR DO SERVICO


InscricaoPrestador
CNPJPrestador

1-1
1-1

Inscrio municipal do prestador que emitiu a NFSE


Nmero do CNPJ do Prestador do Servio

DETALHAMENTO ESPECIFICO DA CONTRUCAO CIVIL


CodigodaObra
ART

0-1
0-1

Nmero da matricula CEI da obra ou da empresa


Nmero da ART

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

2 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE


2.1.1 Recepo e Processamento de Lote de Registros de Prestao de Servios
RPS 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 lote
entrar na fila para processamento posterior onde sero feitas as validaes necessrias e
gerao das NFSE.
Passos para execuo

1- A aplicao acessa o servio de Recepo e Processamento de Lote de RPS enviando o


lote (fluxo b).
2- A requisio recebida pelo servidor do Web Service que grava as informaes recebidas e gera
o 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.

Passos para execuo


1. 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 ou
as 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 para execuo

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.c e 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 execuo


1. A aplicao acessa o servio de Consulta de NFSE por RPS e 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 e 2.d).
3. O Web Service retorna uma mensagem com o resultado do processamento do servio
(fluxo 2.e).

2.1.5 Consulta de Lote de RPS


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

Passos para execuo


1. A aplicao acessa o servio de Consulta de Lote de RPS e submete os dados
para processamento (fluxo b).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFSE correspondentes (fluxos c e d).
3. O Web Service retorna uma mensagem (a estrutura com a lista da NFSE geradas
ou 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 para execuo


1. A aplicao acessa o servio de Consulta de NFSE e 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.

2.1.7 Cancelamento de NFSE


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

Passos para execuo


1. A aplicao acessa o servio de Cancelamento de NFSE e 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 (fluxo
2.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.

Passos para execuo


1. A aplicao acessa o servio de Consulta de NFSE por faixa e 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.

2.2 - PADRES TCNICOS


2
.
2
.
1
P
a
d
2.2.1 Padro de Comunicao
O meio fsico de comunicao utilizado entre o sistema de informao dos contribuintes e o
sistema da NFSE da Secretaria Municipal da Fazenda ser a Internet, com o uso do protocolo
SSL, que alm de garantir um duto de comunicao seguro na Internet, permite a identificao
do servidor e do cliente atravs de certificados digitais, eliminando a necessidade de
identificao 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 Municipal
da Fazenda e o sistema do contribuinte ser realizada no padro SOAP, com troca de
mensagens XML no padro Style/Enconding: Document/Literal, wrapped. A opo wrapped
representa a chamada aos mtodos disponveis com a passagem de mais de um parmetro.
Para descrever os servios disponibilizados, ser utilizado um documento WSDL (Web Service
Description Language). O WSDL o padro recomendado para descrio de servios SOAP.

SOAP
Requerente
do Servio

Provedor
do Servio

As chamadas aos servios sero feitas enviando como parmetro um documento XML a
ser processado pelo sistema. Esse documento no far parte da descrio do servio (arquivo
WSDL), 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 da
Fazenda sero emitidos por Autoridade Certificadora credenciada pela Infra-estrutura
de 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 digital
seja de quaisquer dos estabelecimentos da empresa.
Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao entre o
sistema do contribuinte e o Web Service da Secretaria Municipal da Fazenda:

Assinatura de Mensagens: O certificado digital utilizado para essa funo dever conter o
CNPJ do estabelecimento emissor da NFSE ou o CNPJ do estabelecimento matriz. O
certificado digital dever ter o uso da chave previsto 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): O
certificado digital utilizado para identificao do aplicativo do contribuinte dever conter o
CNPJ do responsvel pela transmisso das mensagens, mas no necessita ser o mesmo
CNPJ do estabelecimento emissor da NFSE, devendo ter a extenso extended Key
Usage com permisso de Autenticao Cliente.
2.2.3 Padro de Assinatura Digital

As mensagens enviadas aos servios disponibilizados pela Secretaria Municipal da


Fazenda so documentos eletrnicos elaborados no padro XML e devem ser assinados
digitalmente com um certificado digital que contenha o CNPJ do estabelecimento matriz
ou o CNPJ do estabelecimento emissor da NFSE objeto do pedido.
Para garantir a integridade das informaes prestadas e a correta formao dos
arquivos XML, o contribuinte dever submeter as mensagens XML para validao
pela linguagem de Schema do XML (XSD XML Schema Definition), disponibilizada
pela Secretaria Municipal da Fazenda antes de seu envio.
Os elementos a seguir esto presentes dentro do Certificado do contribuinte tornando
desnecessria a sua representao individualizada no arquivo XML. Portanto, o arquivo
XML no deve conter os elementos:
<X509SubjectName>
<X509IssuerSerial>
<X509IssuerName>
<X509SerialNumber>
<X509SKI>

Deve-se evitar o uso das TAGs a seguir, pois as informaes sero obtidas a partir do
Certificado do emitente:
<KeyValue>
<RSAKeyValue>
<Modulus>
<Exponent>
O Projeto NFSE utiliza um subconjunto do padro de assinatura XML definido pelo
W3C (http://www.w3.org/TR/xmldsig-core/), que tem o seguinte leiaute:
#
XS01
XS02
XS03
XS04
XS05

Campo
Signature
Id
SignedInfo
CanonicalizationMethod
Algorithm

Elemento
Raiz
A
G
G
A

Pai

XS01 C
XS01
XS03
XS04 C

1-1
1-1
1-1
1-1

Grupo da Informao da assinatura


Grupo do Mtodo de Canonicalizao
Atributo Algorithm de CanonicalizationMethod:

XS06 SignatureMethod
XS07 Algorithm

G
A

XS03
XS06 C

1-1
1-1

Grupo do Mtodo de Assinatura


Atributo
Algorithm
de

XS08
XS09
XS10
XS11

G
A
G
RC

XS03
XS08 C
XS08
XS10

1-1
1-1
1-1
1-1

XS12 Transform
XS13 Algorithm

G
A

XS10
XS12 C

2-2
1-1

Grupo do Mtodo de Reference


Atributo URI da tag Reference
Grupo do algorithm de Transform
Regra para o atributo Algorithm do Transform ser
nico
Grupo de Transform
Atributos vlidos Algorithm do Transform:

XS14 Xpath
XS15 DigestMethod
XS16 Algorithm

E
G
A

XS12 C
XS08
XS15 C

0-N
1-1
1-1

Xpath
Grupo do Mtodo de DigestMethod
Atributo
Algorithm
de
DigestMethod:

XS17
XS18
XS19
XS20
XS21

E
G
G
G
E

XS08 C
XS01
XS01
XS19
XS20 C

1
1-1
1-1
1-1
1-1

Digest Value (Hash SHA-1 Base64)


Grupo do Signature Value
Grupo do KeyInfo
Grupo X509
Certificado Digital x509 em Base64b

Reference
URI
Transforms
Unique_Transf_Alg

DigestValue
SignatureValue
KeyInfo
X509Data
X509Certificate

Tipo Ocorrncia Descrio

http://www.w3.org/TR/2001/REC-xml-c14n20010315
SignedInfo:

http://www.w3.org/2000/09/xmldsig#rsasha1

http://www.w3.org/TR/2001/REC-xml-c14n20010315
http://www.w3.org/2000/09/xmldsig#envelop
ed-signature

http://www.w3.org/2000/09/xmldsig#sha1

2.2.4 Uso de Assinatura com Certificado Digital


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

O RPS Registro de Prestao de Servios, pelo contribuinte, antes do envio do mesmo


atravs 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;

2.3 - PADRO DAS MENSAGENS XML


A especificao adotada para as mensagens XML a recomendao W3C para XML
1.0, disponvel em HTTP://www.w3.org/TR/REC-xml e a codificao dos caracteres ser em
UTF-8.
As chamadas dos Web Services disponibilizados pela Secretaria Municipal da Fazenda e os
respectivos resultados do processamento so realizadas atravs das mensagens com o
seguinte padro:

rea de Cabealho estrutura XML padro para todas as mensagens de chamada


e retorno de resultado dos Web Services disponibilizados pela Secretaria Municipal da
Fazenda, que contm os dados de controle da mensagem. A rea de cabealho est
sendo utilizada para armazenar a verso do leiaute da estrutura XML informado na rea
de dados
rea de Dados estrutura XML varivel definida na documentao do Web
Service acessado.
2.3.1 rea do Cabealho

A seguir, o leiaute da rea de Cabealho padro:


#
1

Nome
cabecalho

Elemento
G

Pai Tipo

Verso
versaoDados

A
E

1
1

N
N

Ocorrncia Tamanho Descrio


1-1
TAG raiz
do cabealho da
mensagem.
1-1
4
Verso do leiaute.
1-1
4
O contedo deste campo indica a
verso do leiaut e XML da estrutura
XML informada na rea de dados da
mensagem.

O campo versaoDados deve conter a informao da verso do leiaute da estrutura XML


armazenada na rea de dados da mensagem.
A estrutura XML armazenada na rea de dados est definida na documentao do Web
Service acessado.
2.3.2 Validao da estrutura das Mensagens XML
Para garantir minimamente a integridade das informaes prestadas e a
correta formao das mensagens XML, o contribuinte dever submeter
cada uma das mensagens XML de pedido de servio para validao pelo
arquivo XSD (XML Schema Definition, definio de esquemas XML) antes de
seu envio. Neste manual utilizaremos a nomenclatura Schema XML para
nos referir a arquivo XSD.
Qualquer divergncia da estrutura da mensagem XML em relao ao
Schema XML, provoca um erro de validao do Schema XML. Neste caso
o 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 gerar
mensagens 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 Porto
Alegre.

2.3.4 Verso dos Schema XML


Toda mudana de layout das mensagens XML do Web Service implica na atualizao do
Schema XML.
A identificao da verso do Schema XML ser realizada com o acrscimo do nmero da
verso com dois dgitos no nome do arquivo XSD precedida da literal _v, como segue:
<Nome do Arquivo>_v<Nmero da Verso>.xsd
Exemplo: SCHEMA_v01.xsd

3 ESTRUTURA DE DADOS DO WEB SERVICE


Existir um nico Web Service com todos os servios apresentados no item 2. O fluxo de
comunicao sempre iniciado pelo sistema do contribuinte atravs do envio de uma
mensagem 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 forma
assncrona e as demais solicitaes de servios de forma sncrona.
Assim, os servios da NFSE sero implementados da seguinte forma:

Servio
Recepo e Processamento de Lote de RPS
Gerao de NFSE
Consulta de Situao de Lote de RPS
Consulta de NFSE por RPS
Consulta de Lote de RPS
Consulta de NFSE
Cancelamento de NFSE
Consulta de NFSE por faixa

Implementao
Assncrona
Sncrona
Sncrona
Sncrona
Sncrona
Sncrona
Sncrona
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
Data (date)

Observao

Formato: AAAA-MM-DD
onde:
AAAA = ano com 4 caracteres
MM = ms com 2 caracteres
DD = dia com 2 caracteres
Data/Hora (datetime)
Formato AAAA-MM-DDTHH:mm:ss
onde:
AAAA = ano com 4 caracteres
MM = ms com 2 caracteres
DD = dia com 2 caracteres
T = caractere de formatao que deve existir separando a data da hora
HH = hora com 2 caracteres
mm: minuto com 2 caracteres
ss: segundo com 2 caracteres
Valores
Decimais Formato: 0.00
(decimal)
No deve ser utilizado separador de milhar. O ponto (.) deve ser
utilizado para separar a parte inteira da fracionria.
Exemplo:
48.562,25 = 48562.25
1,00 = 1.00 ou 1
0,50 = 0.50 ou 0.5
Valores
Percentuais Formato 0.0000
(decimal)
O
formato em percentual presume o valor percentual em sua forma
fracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira da
fracionria.
Exemplo:
62% = 0.62
150% = 1.5
25,32 =0.2532

No deve ser inserido caractere no significativo para preencher o tamanho completo do


campo, ou seja, zeros antes de nmero ou espao em branco aps cadeia de caracteres. A
posio do campo definida na estrutura do documento XML atravs de TAGs
(<tag>contedo</tag>).
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 por
estar condicionado legislao especfica ou ao negcio do contribuinte. Neste caso, dever
constar a TAG com o valor correspondente e, para os demais campos, devero ser eliminadas
as TAGs.
Para reduzir o tamanho final do arquivo XML da NFSE alguns cuidados de programao devero
ser 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 de
dados. 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 o
texto 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: 15 significa 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.

Campo

Tipo Descrio

Tam.

TsNumeroNfse

15

tsCodigoVerificacao
TsStatusRps

C
N

TsStatusNfse

tsNaturezaOperacao

tsRegimeEspecialTributacao

TsSimNao

TsQuantidadeRps
TsNumeroRps
TsSerieRps
TsTipoRps

N
N
C
N

tsOutrasInformacoes
TsValor

C
N

tsItemListaServico
TsCodigoCnae
tsCodigoTributacao
TsAliquota

C
N
C
N

tsDiscriminacao
tsCodigoMunicipioIbge

C
N

tsIncricaoMunicipal
tsRazaoSocial
tsNomeFantasia
TsCnpj
tsEndereco
tsNumeroEndereco
tsComplementoEndereco
tsBairro

C
C
C
C
C
C
C
C

Nmero da Nota Fiscal de Servio Eletrnica,


formado pelo ano com 04 (quatro) dgitos e um
nmero seqencial com 11 posies Formato
AAAANNNNNNNNNNN.
Cdigo de verificao do nmero da nota
Cdigo de status do RPS
1 Normal
2 Cancelado
Cdigo de status da NFSE
1 Normal
2 Cancelado
Cdigo de natureza da operao
1 Tributao no municpio
2 - Tributao fora do municpio
3 - Iseno
4 - Imune
5 Exigibilidade suspensa por deciso judicial
6 Exigibilidade suspensa por procedimento
administrativo
Cdigo de identificao do regime especial de
tributao
1 Microempresa municipal
2 - Estimativa
3 Sociedade de profissionais
4 Cooperativa
5 MEI Simples Nacional
6 ME EPP Simples Nacional
Identificao de Sim/No
1 - Sim
2 No
Quantidade de RPS do Lote
Nmero do RPS
Nmero de srie do RPS
Cdigo de tipo de RPS
1 - RPS
2 Nota Fiscal Conjugada (Mista)
3 Cupom
Informaes adicionais ao documento.
Valor monetrio.
Formato: 0.00 (ponto separando casa decimal)
Ex: 1.234,56 = 1234.56
1.000,00 = 1000.00
1.000,00 = 1000
Cdigo de item da lista de servio
Cdigo CNAE
Cdigo de Tributao
Alquota. Valor percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou 1
Discriminao do contedo da NFSE
Cdigo de identificao do municpio conforme
tabela do IBGE
Nmero de inscrio municipal
Razo Social do contribuinte
Nome fantasia
Nmero CNPJ
Endereo
Nmero do endereo
Complemento de endereo
Bairro

9
1

1
2

4
15
5
1

255
15,2

5
7
20
5,4

2000
7
15
115
60
14
125
10
60
60

tsUf
tsCep
tsEmail
tsTelefone
TsCpf
tsIndicacaoCpfCnpj

C
N
C
C
C
N

tsCodigoObra
tsArt
tsNumeroLote
TsNumeroProtocolo
tsSituacaoLoteRps

C
C
N
C
N

tsCodigoMensagemAlerta
TsDescricaoMensagemAlerta
TsCodigoCancelamentoNfse

C
C
C

tsIdTag

tsPagina

Sigla da unidade federativa


2
Nmero do CEP
8
E-mail
80
Telefone
11
Nmero de CPF
11
Indicador de uso de CPF ou CNPJ
1
1 CPF
2 CNPJ
3 No Informado
Cdigo de Obra
15
Cdigo ART
15
Nmero do Lote de RPS
15
Nmero do protocolo de recebimento do RPS
50
Cdigo de situao de lote de RPS
1
1 No Recebido
2 No Processado
3 Processado com Erro
4 Processado com Sucesso
Cdigo de mensagem de retorno de servio.
4
Descrio da mensagem de retorno de servio.
200
Cdigo de cancelamento com base na tabela de 4
Erros e alertas.
Atributo de identificao da tag a ser
255
assinada no documento XML
Nmero da pgina da consulta
6

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

3.4 - TIPOS COMPLEXOS


A seguir sero detalhadas as tabelas de cada tipo composto e seus campos. A tabela
est dividida da seguinte forma:
(1)
(2)
Nome
(3)

(4)
(4)

Tipo
(5)
(5)

Ocorrncia Descrio
(6)
(7)
(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 a
quantidade mxima for indefinida, ser utilizado N no lugar do y;
7. Descrio do campo.
TcCpfCnpj
Nmero de CPF ou CNPJ
Nome
Cpf
Choice
Cnpj

Tipo
tsCpf
tsCnpj

Ocorrncia Descrio
1-1
Nmero do Cpf
1-1
Nmero do Cnpj

TcEndereco
Representao completa do endereo
Nome
Tipo
Endereco
tsEndereco
Numero
tsNumeroEndereco

Ocorrncia Descrio
1-1
Endereo
1-1
Nmero do endereo

Complemento
Bairro
CodigoMunicipio
Uf
Cep

tsComplementoEndereco
tsBairro
tsCodigoMunicipioIbge
tsUf
tsCep

0-1
1-1
1-1
1-1
1-1

Complemento do Endereo
Nome do bairro
Cdigo da cidade
Sigla do estado
CEP da localidade

TcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Nome
Tipo
Telefone
tsTelefone
Email
tsEmail

Ocorrncia Descrio
0-1
0-1

tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador
Nome
Tipo
CodigoMunicipio
tsCodigoMunicipioIbge
Uf
tsUf

Ocorrncia Descrio
1-1
1-1

tcIdentificacaoRps
Dados de identificao do RPS
Nome
Tipo
Numero
tsNumeroRps
Serie
tsSerieRps
Tipo
tsTipoRps

Ocorrncia Descrio
1-1
1-1
1-1

tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
Nome
Tipo
Cnpj
tsCnpj
InscricaoMunicipal
tsInscricaoMunicipal

Ocorrncia Descrio
1-1
1-1

tcIdentificacaoTomador
Representa dados para identificao do tomador de servio
Nome
Tipo
CpfCnpj
tcCpfCnpj
InscricaoMunicipal
tsInscricaoMunicipal

Ocorrncia Descrio
0-1
0-1

tcDadosTomador
Representa dados do tomador de servio
Nome
Tipo
IdentificacaoTomador
TcIdentificacaoTomador
RazaoSocial
TsRazaoSocial
Endereco
TcEndereco
Contato
TcContato

Ocorrncia Descrio
0-1
1-1
1-1
0-1

TcIdentificacaoIntermediarioServico
Representa dados para identificao de intermedirio do servio
Nome
Tipo
Ocorrncia Descrio
RazaoSocial
tsRazaoSocial
1-1
CpfCnpj
tcCpfCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1

TcValores
Representa um conjunto de valores que compe o documento fiscal
Nome
Tipo
Ocorrncia Descrio
ValorServicos
tsValor
1-1
ValorDeducoes
tsValor
0-1
ValorPis
tsValor
0-1
ValorCofins
tsValor
0-1
ValorInss
tsValor
0-1
ValorIr
tsValor
0-1

ValorCsll
IssRetido
ValorIss
OutrasRetencoes
BaseCalculo

tsValor
tsSimNao
tsValor
tsValor
tsValor

0-1
1-1
0-1
0-1
0-1

Aliquota
ValorLiquidoNfse

tsAliquota
tsValor

0-1
0-1

ValorIssRetido
DescontoCondicionado
DescontoIncondicionado

tsValor
tsValor
tsValor

0-1
0-1
0-1

(Valor dos servios - Valor


das dedues - descontos
incondicionados)
(ValorServicos - ValorPISValorCOFINS - ValorINSS
ValorIR

ValorCSLLOutrasRetenoes
ValorISSRetido DescontoIncondicionado
DescontoCondicionado)

TcDadosServico
Representa dados que compe o servio prestado
Nome
Tipo
Valores
tcValores
ItemListaServico
tsItemListaServico
CodigoCnae
tsCodigoCnae
CodigoTributacaoMunicipio tsCodigoTributacao
Discriminacao
tsDiscriminacao
CodigoMunicipio
tsCodigoMunicipioIbge

Ocorrncia Descrio
1-1
1-1
0-1
1-1
1-1
1-1

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
Nome
Tipo
CodigoObra
tsCodigoObra
Art
tsArt

Ocorrncia Descrio
1-1
1-1

tcDadosPrestador
Representa dados do prestador do servio
Nome
Tipo
IdentificacaoPrestador
tcIdentificacaoPrestador
RazaoSocial
tsRazaoSocial
NomeFantasia
tsNomeFantasia
Endereco
tcEndereco
Contato
tcContato

Ocorrncia Descrio
1-1
1-1
0-1
1-1
0-1

TcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS)
Nome
Tipo
Ocorrncia Descrio
Id
tsIdTag
Identificador da TAG
a ser assinada
IdentificacaoRps
TcIdentificacaoRps
1-1
Transforma-se em
DataEmissao
Datetime
1-1
Competencia no TcInfNfse
NaturezaOperacao
TsNaturezaOperacao
1-1
RegimeEspecialTributacao TsRegimeEspecialTributacao
0-1
OptanteSimplesNacional
TsSimNao
1-1
IncentivadorCultural
TsSimNao
1-1
Status
TsStatusRps
1-1
RpsSubstituido
TcIdentificacaoRps
0-1
Servico
TcDadosServico
1-1
Prestador
TcIdentificacaoPrestador
1-1
Tomador
TcDadosTomador
1-1
IntermediarioServico
tcIdentificacaoIntermediarioServico 0-1
ConstrucaoCivil
TcDadosConstrucaoCivil
0-1

TcRps
Representa a estrutura do Registro de Prestao de Servio (RPS) assinado
Nome
Tipo
Ocorrncia Descrio
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-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
1-1
CodigoMunicipio
tsCodigoMunicipioIbge

TcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Nome
Tipo
Ocorrncia Descrio
Id
tsIdTag
Identificador da TAG
a ser assinada
Numero
tsNumeroNfse
1-1
CodigoVerificacao
tsCodigoVerificacao
1-1
DataEmissao
Datetime
1-1
IdentificacaoRps
tcIdentificacaoRps
0-1
DataEmissaoRps
Date
0-1
NaturezaOperacao
tsNaturezaOperacao
1-1
RegimeEspecialTributacao tsRegimeEspecialTributacao
0-1
OptanteSimplesNacional
TsSimNao
1-1
IncetivadorCultural
TsSimNao
1-1
Competencia
Datetime
1-1
NfseSubstituida
tsNumeroNfse
0-1
OutrasInformacoes
tsOutrasInformacoes
0-1
Servico
tcDadosServico
1-1
ValorCredito
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

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar
uma
Nota Fiscal de Servios Eletrnica.
Nome
Tipo
Ocorrncia Observao
Id
tsIdTag
Identificador da TAG a ser
assinada
IdentificacaoNfse
tcIdentificacaoNfse
1-1
CodigoCancelamento
tsCodigoCancelamentoNfse
1-1

TcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
InfPedidoCancelamento
tcInfPedidoCancelamento
1-1
Signature
Dsig:Signature
0-1

tcLoteRps3
Nome
Id

Tipo
tsIdTag

Ocorrncia Observao
Identificador da TAG a ser
assinada

NumeroLote
Cnpj
InscricaoMunicipal
QuantidadeRps
ListaRps
Rps

TsNumeroLote
TsCnpj
TsInscricaoMunicipal
TsQuantidadeRps
TcRps

1-1
1-1
1-1
1-1
1-1
1-3

TcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
Id
tsIdTag
Identificador da TAG
a ser assinada
Pedido
TcPedidoCancelamento
1-1
DataHora
datetime
1-1

TcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFSE.
Nome
Tipo
Ocorrncia Descrio
Confirmacao
TcConfirmacaoCancelamento
1-1
Signature
Dsig:Signature
1-1

TcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFSE.
Nome
Tipo
Id
tsIdTag
NfseSubstituidora

tsNumeroNfse

Ocorrncia Descrio
Identificador da TAG a ser
assinada
1-1

TcSubstituicaoNfse
Representa a estrutura de substituio de NFSE.
Nome
Tipo
SubstituicaoNfse
tcInfSubstituicaoNfse
Signature
dsig:Signature

Ocorrncia Descrio
1-1
1-2

TcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFSE.
Nome
Tipo
Ocorrncia Descrio
Nfse
tcNfse
1-1
NfseCancelamento
tcCancelamentoNfse
0-1
NfseSubstituicao
tcSubstituicaoNfse
0-1

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Codigo
TsCodigoMensagemAlerta
Mensagem
tsDescricaoMensagemAlerta
Correcao
tsDescricaoMensagemAlerta

Ocorrncia Descrio
1-1
1-1
0-1

ListaMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
MensagemRetorno
tcMensagemRetorno

Ocorrncia Descrio
1- N

tcMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
IdentificacaoRps
TcIdentificacaoRps
Codigo
TsCodigoMensagemAlerta
Mensagem
tsDescricaoMensagemAlerta

Ocorrncia Descrio
1-1
1-1
1-1

tcLoteRps
Nome
Id
NumeroLote
Cnpj
InscricaoMunicipal
QuantidadeRps
ListaRps
Rps

Tipo
tsIdTag
TsNumeroLote
TsCnpj
TsInscricaoMunicipal
TsQuantidadeRps
TcRps

Ocorrncia Observao
Identificador da TAG a ser
assinada
1-1
1-1
1-1
1-1
1-1
1-N

3.5 - SERVIOS
A seguir esto os servios disponveis, conforme descritos no item 2, no WebService
e seu XML Schema. O XML Schema define a estrutura e formatao do arquivo XML que
conter 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 em
2.2.1.
As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
(1)
# Nome
(2 (3)
)

Tipo
(4)

Pai
(5)

Ocorrncia
(6)
(8)

Observao
(7)
(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 a
quantidade mxima for indefinida, ser utilizado N no 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 mtodo
RecepcionarLoteRps, passando a mensagem XML como parmetro com a estrutura definida
na tabela que segue.
nfse.xsd
#
1

Nome
EnviarLoteRpsEnvio
LoteRps

Signature

Tipo

Pai

TcLoteRps
dsig:Signature

1
1

Ocorrncia Observao
1-1
1-1
0-1

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


nfse.xsd
#
1

Nome
EnviarLoteRpsResposta
NumeroLote
DataRecebimento
Protocolo
ListaMensagemRetorno

Tipo

Pai

tsNumeroLote
Datetime
tsNumeroProtocolo
ListaMensagemRetorno

1
1
1
1

Ocorrncia Observao
1-1
1-1
1-1

Choice

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
#
1

Nome
GerarNfseEnvio
LoteRps

Signature

Tipo

Pai

TcLoteRps3
dsig:Signature

1
1

Ocorrncia Observao
1-1
1-1
0-1

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


nfse.xsd
#

Nome

GerarNfseResposta
NumeroLote
DataRecebimento
Protocolo
ListaMensagemRetorno
ListaMensagemRetornoLote
ListaNfse
CompNfse

2
3
4

Tipo

Pai

TsNumeroLote
Datetime
tsNumeroProtocolo
ListaMensagemRetorno
ListaMensagemRetornoLote

1
1
1
1
1
1
4

tcCompNfse

Ocorrnci
a
1-1
0-1
0-1
0-1
1-1
1-1
1-1
1-N

Observao

Choice

3.5.3 - Consulta de Situao de Lote de RPS.


Esse
servio
ser
executado
atravs
da
chamada
ao
mtodo
ConsultarSituacaoLoteRps, passando a mensagem XML como parmetro com a estrutura
definida na tabela que segue.
nfse.xsd
# Nome
1 ConsultarSituacaoLoteRpsEn
vio
Prestador
Protocolo

Tipo

Pai

TcIdentificacaoPrestador
TsNumeroProtocolo

1
1

Ocorrncia Observao
1-1
1-1
1-1

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


nfse.xsd
#
1

Nome
ConsultarSituacaoLoteRpsResp
osta
NumeroLote
Situao
ListaMensagemRetorno

Tipo

Pai

tsNumeroLote
tsSituacaoLoteRps
ListaMensagemRetorno

1
1
1

Ocorrncia Observao
1-1
1-1
1-1

Choice

3.5.4 - Consulta de NFSE por RPS


Esse servio ser executado atravs da chamada ao mtodo ConsultarNfsePorRps, passando
a mensagem XML como parmetro com a estrutura definida na tabela que segue.
nfse.xsd
# Nome
1 ConsultarNfseRpsEnvio
IdentificacaoRps
Prestador

Tipo

Pai

Ocorrncia Observao

tcIdentificacaoRps
tcIdentificacaoPrestador

1
1

1-1
1-1

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


nfse.xsd
# Nome
1 ConsultarNfseRpsResposta
CompNfse
2 ListaMensagemRetorno

Tipo

Pai

Ocorrncia Observao

tcCompNfse
ListaMensagemRetorno

1
1

1-1
1-1

Choice

3.5.5 - Consulta de NFSE


Esse servio ser executado atravs da chamada ao mtodo ConsultarNfse, passando a
mensagem XML como parmetro com a estrutura definida na tabela que segue.
nfse.xsd
# Nome
1 ConsultarNfseEnvio
Prestador
NumeroNfse
2 PeriodoEmissao
DataInicial
DataFinal
Tomador
IntermediarioServico

Tipo
tcIdentificacaoPrestador
tsNumeroNfse
date
date
tcIdentificacaoTomador
TcIdentificacaoIntermediarioServico

Pai Ocorrncia Observao


1-1
1
1-1
1
0-1
1
0-1
2
1-1
2
1-1
1
0-1
1
0-1

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


nfse.xsd
#
1
2
3

Nome
ConsultarNfseResposta
ListaNfse
CompNfse
ListaMensagemRetorno

Tipo

Pai

tcCompNfse
ListaMensagemRetorno

1
2
1

Ocorrncia Observao
1-1
1-1
Choice
0-N
1-1

3.5.6 - Consulta de Lote de RPS


Esse servio ser executado atravs da chamada ao mtodo ConsultarLoteRps, passando
a mensagem XML como parmetro com a estrutura definida na tabela que segue.
nfse.xsd
# Nome
1 ConsultarLoteRpsEnvio
Prestador
Protocolo

Tipo

Pai

TcIdentificacaoPrestador
TsNumeroProtocolo

1
1

Ocorrncia Observao
1-1
1-1
1-1

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


nfse.xsd
#
1
2
3

Nome
ConsultarLoteRpsResposta
ListaNfse
CompNfse
ListaMensagemRetorno

Tipo

Pai

tcCompNfse
ListaMensagemRetorno

1
2
1

Ocorrncia Observao
1-1
1-1
Choice
1-N
1-1

3.5.7 - Cancelamento NFSE


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

Nome
CancelarNfseEnvio
Pedido

Tipo

Pai

TcPedidoCancelamento

Ocorrncia Observao
1-1
1-1

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


nfse.xsd
#
1
2

Nome
CancelarNfseResposta
Cancelamento
ListaMensagemRetorno

Tipo

Pai

Ocorrncia Observao

TcCancelamentoNfse
ListaMensagemRetorno

1
1

1-1
1-1

Choice

3.5.8 Consulta de NFSE por faixa


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

nfse.xsd
# Nome

Tipo

1 ConsultarNfseFaixaEnvio
Prestador

tcIdentificacaoPrestador

2 Faixa

Pai Ocorrncia Observao


a
1-1
1

1-1

0-1

NumeroNfseInicial

tsNumeroNfse

1-1

NumeroNfseFinal

tsNumeroNfse

1-1

Pagina

tsPagina

1-1

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


nfse.xsd
#

Nome

ConsultarNfseFaixaResposta

ListaNfse

Tipo

Pai Ocorrncia Observao


a

1-1

1-1

CompNfse

CompNfse

1 - 50

Pagina

tsPagina

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice