Escolar Documentos
Profissional Documentos
Cultura Documentos
Verso 2.02
Novembro/2012
Pgina 2 de 42
Reviso 2.02
SUMRIO
1
INTRODUO ..................................................................................................... 4
Pgina 3 de 42
Reviso 2.02
4.5.7
4.5.8
4.5.9
4.5.10
Pgina 4 de 42
Reviso 2.02
1 INTRODUO
Este manual tem como objetivo apresentar as especificaes e
critrios tcnicos necessrios para utilizao do Web Service
disponibilizado pelas Administraes Tributrias Municipais para
as empresas prestadoras e/ou tomadoras de servios.
Utilizando o Web Service as empresas podero integrar seus
prprios sistemas de informaes com o Sistema de Notas
Fiscais de Servio Eletrnicas das Administraes Tributrias
Municipais. Desta forma, consegue-se automatizar o processo de
gerao, consulta e cancelamento de NFS-e.
Pgina 5 de 42
Reviso 2.02
2 CONSIDERAES INICIAIS
O projeto Nota Fiscal de Servios Eletrnica est sendo concebido
em reunies das reas de Negcio e Tecnologia da Informao com
os representantes dos municpios integrantes da Cmara Tcnica
da Associao Brasileira de Secretrios e Dirigentes das Finanas
dos Municpios das Capitais (ABRASF), que tiveram como principal
objetivo a gerao de um modelo de processo que considerasse as
necessidades e as legislaes de cada municpio.
O projeto tem como objetivo atender ao Protocolo de Cooperao
ENAT n 01/2006 - III ENAT, que instituiu a Nota Fiscal de Servios
Eletrnica NFS-e com vistas ao compartilhamento de informaes
entre os fiscos municipais, estaduais e federal, por meio do
desenvolvimento de uma soluo para a gerao desse documento fiscal eletrnico como
instrumento de controle da arrecadao e fiscalizao do ISS.
Visa a beneficiar as administraes tributrias padronizando e melhorando a qualidade das
informaes, racionalizando os custos e gerando maior eficcia, bem como aumentar a
competitividade das empresas brasileiras pela racionalizao das obrigaes acessrias
(reduo do custo-Brasil), em especial a dispensa da emisso e guarda de documentos em
papel.
2.1
2.2
A NFS-e somente ser gerada com a utilizao dos servios informatizados disponibilizados
pelas Administraes Tributrias Municipais. Esse tipo de servio pressupe riscos inerentes
ininterrupta disponibilidade, podendo, eventualmente, em alguns momentos tornar-se
indisponvel.
Visando manter as atividades dos contribuintes ininterruptas, independente de os servios
informatizados disponibilizados pelas Administraes Tributrias Municipais estarem
Pgina 6 de 42
Reviso 2.02
Pgina 7 de 42
Reviso 2.02
Modelo Conceitual
Aplicao Cliente
b
<XML>
Lote de RPS
c
NFS-e
a
d
RPS
<XML>
Mensagem
Web Services
NFS-e
Fila de Processos
Pgina 8 de 42
Reviso 2.02
Prestador
Aplicao Cliente
2.c
<XML>
Lote de RPS
2.b
Consistncia
2.a
2.e
Web Services
<XML>
NFS-e / Mensag.
2.d
NFS-e
Processamento
Resultado
Aplicao Cliente
2.b
2.c
<XML>
RPS
Consistncia
2.a
2.e
<XML>
NFS-e / Mensag.
Web Services
2.d
NFS-e
Processamento
Resultado
Pgina 9 de 42
Reviso 2.02
Prestador
Aplicao Cliente
2.b
<XML>
Identif. da NFS-e
Cancelamento
2.a
2.c
2.d
<XML>
NFS-e / Mensag.
Web Services
Processamento
NFS-e
Pgina 10 de 42
Reviso 2.02
Prestador
Aplicao Cliente
b
Web Services
<XML>
Identif. do RPS
Consulta
e
<XML>
Grupo de NFS-e / Msg.
Processamento
NFS-e
NFS-e / Msg
10
Pgina 11 de 42
Reviso 2.02
Prestador ou Tomador
Aplicao Cliente
2.b
<XML>
Identif. do RPS
2.c
2.a
Consulta
2.e
<XML>
NFS-e / Mensag.
Web Services
2.d
Processamento
NFS-e / Msg
NFS-e
Prestador
Aplicao Cliente
2.C
<XML>
2.B
Identif. do RPS
Consulta
2.A
2.E
<XML>
Web Services
2.D
Processamento
NFS-e
NFS-e / Msg
NFS-e / Mensag
11
Pgina 12 de 42
Reviso 2.02
2.C
<XML>
2.B
Identif. do RPS
?
Consulta
2.A
2.E
Web Services
<XML>
2.D
Processamento
NFS-e
NFS-e / Msg
NFS-e / Mensag.
2.c
<XML>
Identif. da NFS-e
Consulta
2.a
2.e
<XML>
NFS-e / Mensag.
Web Services
2.d
Processamento
NFS-e
NFS-e / Msg
12
Pgina 13 de 42
Reviso 2.02
3.2
Padres Tcnicos
HTTPS
REQUISIO
CONTRIBUINTE
13
Pgina 14 de 42
Reviso 2.02
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 est definido neste manual de
integrao, seo 4.5.
14
Pgina 15 de 42
Reviso 2.02
Campo
XS01 Signature
Elemento Pai
Raiz
XS02 Id
XS01
XS03 SignedInfo
XS01
1-1
XS04 CanonicalizationMethod
XS03
1-1
XS05 Algorithm
XS04
1-1
Atributo Algorithm de
CanonicalizationMethod:
http://www.w3.org/TR/2001/REC-xmlc14n-20010315
XS06 SignatureMethod
XS03
1-1
XS07 Algorithm
XS06
1-1
XS08 Reference
XS03
1-1
XS09 URI
XS08
1-1
XS10 Transforms
XS08
1-1
RC
XS10
1-1
XS12 Transform
XS10
2-2
Grupo de Transform
XS13 Algorithm
XS12
1-1
XS11 Unique_Transf_Alg
1-1
15
Pgina 16 de 42
Reviso 2.02
Campo
Elemento Pai
XS14 Xpath
XS12
0-N
Xpath
XS15 DigestMethod
XS08
1-1
XS16 Algorithm
XS15
1-1
XS17 DigestValue
XS08
XS18 SignatureValue
XS01
1-1
XS19 KeyInfo
XS01
1-1
Grupo do KeyInfo
XS20 X509Data
XS19
1-1
Grupo X509
XS21 X509Certificate
XS20
1-1
Observao:
Os RPSs e lote devem ser assinados conforme os seguintes passos:
1. Assinatura do RPS isoladamente neste momento deve ser identificado o
namespace (http://www.abrasf.org.br/nfse.xsd) em cada RPS que ser assinado
2. Agrupar todos os RPS assinados em um nico lote
3. Assinar o lote com os RPS's, tambm identificando o namespace
http://www.abrasf.org.br/nfse.xsd
16
Pgina 17 de 42
Reviso 2.02
3.3
A especificao adotada para as mensagens XML a recomendao W3C para XML 1.0,
disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres ser em UTF-8.
As chamadas dos Web Services disponibilizados Administraes Tributrias Municipais e os
respectivos resultados do processamento so realizadas com utilizao de mensagens com
o seguinte padro:
Nome
cabecalho
Verso
1-1
Verso do leiaute.
versaoDados
1-1
Elemento
Pai
Tipo
Ocorrncia
Tamanho Descrio
1-1
17
Pgina 18 de 42
Reviso 2.02
18
Pgina 19 de 42
Reviso 2.02
Exemplo:
EnvioLoteRps_v01.xsd
A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de
Notas Fiscais de Servio Eletrnicas das Administraes Tributrias Municipais utilizam as
definies de tipos simples ou tipos complexos que esto definidos em outros Schemas
XML. Nesses casos, a modificao de verso do Schema bsico ser repercutida no
Schema principal.
As modificaes de layout das mensagens XML do Web Service podem ser causadas por
necessidades tcnicas ou em razo da modificao de alguma legislao. As modificaes
decorrentes de alterao da legislao devero ser implementadas nos prazos previstos no
ato normativo que introduziu a alterao. As modificaes de ordem tcnica sero
divulgadas pelas Administraes Tributrias Municipais e ocorrero sempre que se fizerem
necessrias.
19
Pgina 20 de 42
Reviso 2.02
4.1
Modelo Operacional
Implementao
Assncrona
Sncrona
Gerao de NFS-e
Sncrona
Cancelamento de NFS-e
Sncrona
Substituio de NFS-e
Sncrona
Sncrona
Sncrona
Sncrona
Sncrona
Sncrona
20
Pgina 21 de 42
Reviso 2.02
Prestador
<XML>
Solicitao
Web Service
<XML>
Resultado
Fila de Processos
21
Pgina 22 de 42
Reviso 2.02
<XML>
Solicitao
Web Services
Processamento
<XML>
Resultado
4.2
Abaixo seguem algumas formataes de dados que devem ser seguidas para gerao
correta na estrutura dos arquivos.
Formato
Observao
Data (date)
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
(decimal)
Formato: 0.00
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
22
Pgina 23 de 42
Reviso 2.02
Formato
Observao
Valores Percentuais
(decimal)
Formato 00.00
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% = 62
15% = 15
25,32 = 25.32
As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser enviada
quando seus valores forem nulos.
4.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:
23
Pgina 24 de 42
Reviso 2.02
o
o
Campo
Tipo
Descrio
Tam.
tsNumeroNfse
15
tsCodigoVerificacao
tsStatusRps
tsStatusNfse
tsExigibilidadeIss
tsNumeroProcesso
30
tsRegimeEspecialTributacao
tsSimNao
Identificao de Sim/No
1 Sim
2 No
tsResponsavelRetencao
tsPagina
tsNumeroRps
Nmero do RPS
15
24
Pgina 25 de 42
Reviso 2.02
Campo
Tipo
Descrio
Tam.
tsSerieRps
tsTipoRps
tsOutrasInformacoes
255
tsValor
Valor monetrio.
Formato: 0.00 (ponto separando casa decimal)
Ex: 1.234,56 = 1234.56
1.000,00 = 1000.00
1.000,00 = 1000
15,2
tsItemListaServico
tsCodigoCnae
Cdigo CNAE
tsCodigoTributacao
Cdigo de Tributao
20
tsAliquota
4,2
tsDiscriminacao
tsCodigoMunicipioIbge
tsInscricaoMunicipal
tsRazaoSocial
tsNomeFantasia
Nome fantasia
60
tsCnpj
Nmero CNPJ
14
tsEndereco
tsNumeroEndereco
Nmero do imvel
10
tsComplementoEndereco
Complemento de endereo
60
tsBairro
Bairro
60
tsUf
tsCodigoPaisBacen
tsCep
Nmero do CEP
tsEmail
80
tsTelefone
Telefone
20
tsCpf
Nmero de CPF
11
tsCodigoObra
Cdigo de Obra
15
tsArt
Cdigo ART
15
tsNumeroLote
15
tsNumeroProtocolo
50
2000
7
15
150
125
25
Pgina 26 de 42
Reviso 2.02
Campo
Tipo
Descrio
Tam.
tsSituacaoLoteRps
tsQuantidadeRps
tsCodigoMensagemAlerta
tsDescricaoMensagemAlerta
200
tsCodigoCancelamentoNfse
tsVersao
Verso do leiaute.
Formato: [1-9]{1}[0-9]{0,1}\.[0-9]{2}
4.4
255
Tipos Complexos
A seguir so detalhadas as tabelas de cada tipo composto e seus campos. A tabela est
dividida da seguinte forma:
(1)
(2)
Nome
Tipo
Ocorrncia Descrio
(4)
(5)
(6)
(7)
(4)
(5)
(6)
(7)
(3)
Legenda da tabela:
(1)
(2)
(3)
(4)
(5)
(6)
26
Pgina 27 de 42
Reviso 2.02
tcCpfCnpj
Nmero de CPF ou CNPJ
Nome
Tipo
Ocorrncia Descrio
Cpf
tsCpf
1-1
Nmero do Cpf
Cnpj
tsCnpj
1-1
Nmero do Cnpj
Choice
tcEndereco
Representao completa do endereo
Nome
Tipo
Ocorrncia Descrio
Endereco
tsEndereco
0-1
Numero
tsNumeroEndereco
0-1
Nmero do imvel
Complemento
tsComplementoEndereco
0-1
Complemento do Endereo
Bairro
tsBairro
0-1
Nome do bairro
CodigoMunicipio
tsCodigoMunicipioIbge
0-1
Cdigo da cidade
Uf
tsUf
0-1
Sigla do estado
CodigoPais
tsCodigoPaisBacen
0-1
Cdigo do pas
Cep
tsCep
0-1
CEP da localidade
tcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Nome
Tipo
Ocorrncia Descrio
Telefone
tsTelefone
0-1
tsEmail
0-1
tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador
Nome
Tipo
Ocorrncia Descrio
CodigoMunicipio
tsCodigoMunicipioIbge
1-1
Uf
tsUf
1-1
tcIdentificacaoRps
Dados de identificao do RPS
Nome
Tipo
Ocorrncia Descrio
Numero
tsNumeroRps
1-1
Serie
tsSerieRps
1-1
Tipo
tsTipoRps
1-1
27
Pgina 28 de 42
Reviso 2.02
tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
Nome
Tipo
Ocorrncia Descrio
CpfCnpj
tcCpfCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
tcIdentificacaoTomador
Representa dados para identificao do tomador de servio
Nome
Tipo
Ocorrncia Descrio
CpfCnpj
tcCpfCnpj
0-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
tcIdentificacaoConsulente
Representa dados para identificao do prestador de servio
Nome
Tipo
Ocorrncia Descrio
CpfCnpj
tcCpfCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
tcIdentificacaoIntermediario
Representa dados para identificao do tomador de servio
Nome
Tipo
Ocorrncia Descrio
CpfCnpj
tcCpfCnpj
0-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
tcDadosTomador
Representa dados do tomador de servio
Nome
Tipo
Ocorrncia Descrio
IdentificacaoTomador
tcIdentificacaoTomador
0-1
RazaoSocial
tsRazaoSocial
0-1
Endereco
tcEndereco
0-1
Contato
tcContato
0-1
tcDadosIntermediario
Representa dados para identificao de intermedirio do servio
Nome
Tipo
Ocorrncia Descrio
IdentificacaoIntermediario
tcIdentificacaoIntermediario
1-1
RazaoSocial
tsRazaoSocial
1-1
28
Pgina 29 de 42
Reviso 2.02
tcValoresDeclaracaoServico
Representa um conjunto de valores que compe a declarao do servio
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
tsValor
0-1
OutrasRetencoes
tsValor
0-1
ValorIss
tsValor
0-1
Aliquota
tsAliquota
0-1
DescontoIncondicionado
tsValor
0-1
DescontoCondicionado
tsValor
0-1
tcValoresNfse
Representa um conjunto de valores que compe o documento fiscal
Nome
Tipo
Ocorrncia Descrio
BaseCalculo
tsValor
0-1
Aliquota
tsAliquota
0-1
ValorIss
tsValor
0-1
ValorLiquidoNfse
tsValor
1-1
(ValorServicos - ValorPIS ValorCOFINS - ValorINSS ValorIR - ValorCSLL OutrasRetenoes ValorISSRetido DescontoIncondicionado DescontoCondicionado)
29
Pgina 30 de 42
Reviso 2.02
tcDadosServico
Representa dados que compe o servio prestado
Nome
Tipo
Ocorrncia
Valores
tcValoresDeclaracaoServico
1-1
IssRetido
tsSimNao
1-1
ResponsavelRetencao
tsResponsavelRetencao
0-1
ItemListaServico
tsItemListaServico
1-1
CodigoCnae
tsCodigoCnae
0-1
CodigoTributacaoMunicipio
tsCodigoTributacao
0-1
Discriminacao
tsDiscriminacao
1-1
CodigoMunicipio
tsCodigoMunicipioIbge
1-1
CodigoPais
tsCodigoPaisBacen
0-1
ExigibilidadeISS
tsExigibilidadeISS
1-1
MunicipioIncidencia
tsCodigoMunicipioIbge
0-1
NumeroProcesso
tsNumeroProcesso
0-1
Descrio
tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
Nome
Tipo
Ocorrncia Descrio
CodigoObra
tsCodigoObra
0-1
Art
tsArt
1-1
tcDadosPrestador
Representa dados do prestador do servio
Nome
Tipo
Ocorrncia Descrio
IdentificacaoPrestador
tcIdentificacaoPrestador
1-1
RazaoSocial
tsRazaoSocial
1-1
NomeFantasia
tsNomeFantasia
0-1
Endereco
tcEndereco
1-1
Contato
tcContato
0-1
30
Pgina 31 de 42
Reviso 2.02
tcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS)
Nome
Tipo
Ocorrncia Descrio
IdentificacaoRps
tcIdentificacaoRps
1-1
DataEmissao
Date
1-1
Status
tsStatusRps
1-1
RpsSubstituido
tcIdentificacaoRps
0-1
Id
tsIdTag
tcInfDeclaracaoPrestacaoServico
Representa dados do da declarao do prestador do servio
Nome
Tipo
Ocorrncia
Rps
tcInfRps
0-1
Competencia
Date
1-1
Servico
tcDadosServico
1-1
Prestador
tcIdentificacaoPrestador
1-1
TomadorServico
tcDadosTomador
0-1
Intermediario
tcDadosIntermediario
0-1
ConstrucaoCivil
tcDadosConstrucaoCivil
0-1
RegimeEspecialTributacao
tsRegimeEspecialTributacao
0-1
OptanteSimplesNacional
tsSimNao
1-1
IncentivoFiscal
tsSimNao
1-1
Id
tsIdTag
Descrio
Identificador da TAG a
ser assinada
tcDeclaracaoPrestacaoServico
Representa a estrutura da declarao da prestao do servio assinada
Nome
Tipo
Ocorrncia Descrio
InfDeclaracaoPrestacaoServico
tcInfDeclaracaoPrestacaoServico
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
CpfCnpj
tcCpfCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
CodigoMunicipio
tsCodigoMunicipioIbge
1-1
31
Pgina 32 de 42
Reviso 2.02
tcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Nome
Tipo
Ocorrncia Descrio
Numero
tsNumeroNfse
1-1
CodigoVerificacao
tsCodigoVerificacao
1-1
DataEmissao
Datetime
1-1
NfseSubstituida
tsNumeroNfse
0-1
OutrasInformacoes
tsOutrasInformacoes
0-1
ValoresNfse
tcValoresNfse
1-1
ValorCredito
tsValor
0-1
PrestadorServico
tcDadosPrestador
1-1
OrgaoGerador
tcIdentificacaoOrgaoGerador
1-1
DeclaracaoPrestacaoServico
tcDeclaracaoPrestacaoServico
1-1
Id
tsIdTag
tcNfse
Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
InfNfse
tcInfNfse
1-1
Signature
Dsig:Signature
0-1
versao
tsVersao
1-1
tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota
Fiscal de Servios Eletrnica.
Nome
Tipo
Ocorrncia Descrio
IdentificacaoNfse
tcIdentificacaoNfse
1-1
CodigoCancelamento
tsCodigoCancelamentoNfse
0-1
Id
tsIdTag
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
32
Pgina 33 de 42
Reviso 2.02
tcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
Pedido
tcPedidoCancelamento
1-1
DataHora
datetime
1-1
Id
tsIdTag
tcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e
Nome
Tipo
Ocorrncia Descrio
Confirmacao
tcConfirmacaoCancelamento
1-1
Signature
Dsig:Signature
0-1
versao
tsVersao
1-1
tcRetCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
NfseCancelamento
tcCancelamentoNfse
1-1
tcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e.
Nome
Tipo
Ocorrncia Descrio
NfseSubstituidora
tsNumeroNfse
Id
tsIdTag
1-1
Identificador da TAG a ser
assinada
tcSubstituicaoNfse
Representa a estrutura de substituio de NFS-e.
SubstituicaoNfse
tcInfSubstituicaoNfse
1-1
SubstituicaoNfse
Signature
dsig:Signature
0-2
Signature
versao
tsVersao
1-1
versao
33
Pgina 34 de 42
Reviso 2.02
tcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFS-e.
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
Ocorrncia Descrio
Codigo
tsCodigoMensagemAlerta
1-1
Mensagem
tsDescricaoMensagemAlerta
1-1
Correcao
tsDescricaoMensagemAlerta
0-1
tcMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
IdentificacaoRps
tcIdentificacaoRps
1-1
Codigo
tsCodigoMensagemAlerta
1-1
Mensagem
tsDescricaoMensagemAlerta
1-1
tcLoteRps
Representa a estrutura do lote de RPS para fila de processamento
Nome
Tipo
Ocorrncia Descrio
NumeroLote
tsNumeroLote
1-1
CpfCnpj
tcCpfCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
QuantidadeRps
tsQuantidadeRps
1-1
ListaRps
1-1
Rps
tcDeclaracaoPrestacaoServico
Id
tsIdTag
versao
tsVersao
1-N
Identificador da TAG a ser
assinada
1-1
ListaMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
MensagemRetorno
tcMensagemRetornoLote
Ocorrncia Descrio
1-N
34
Pgina 35 de 42
Reviso 2.02
ListaMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
MensagemRetorno
tcMensagemRetorno
1-N
ListaMensagemAlertaRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
MensagemRetorno
tcMensagemRetorno
1-N
cabecalho
Representa a estrutura do cabealho
Nome
Tipo
versaoDados
tsVersao
versao
tsVersao
Ocorrncia Descrio
1-1
CompNfse
Representa a estrutura da NFS-e.
Nome
Tipo
CompNfse
tcCompNfse
4.5
Ocorrncia Descrio
1-1
Servios
Nome
(2)
Tipo
(3)
(4)
Pai
Ocorrncia
(5)
(6)
Observao
(7)
(8)
(9)
Legenda da tabela:
(1)
(2)
(3)
Elemento
Nmero identificador do campo, quando este contiver subitens;
Nome do campo;
35
Pgina 36 de 42
Reviso 2.02
(4)
(5)
(6)
Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo;
Indica qual o campo pai, para definio da hierarquia;
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).
Nome
EnviarLoteRpsEnvio
Tipo
Pai
Ocorrncia
LoteRps
tcLoteRps
1-1
Signature
dsig:Signature
0-1
Observao
Nome
EnviarLoteRpsResposta
Tipo
Pai
Ocorrncia
Observao
1-1
NumeroLote
tsNumeroLote
DataRecebimento
Datetime
Protocolo
tsNumeroProtocolo
ListaMensagemRetorno
ListaMensagemRetorno
Choice
1-1
1-1
O lote ser processado posteriormente, sendo o seu resultado disponibilizado para consulta.
Nome
EnviarLoteRpsSincronoEnvio
Tipo
Pai
Ocorrncia
Observao
1-1
LoteRps
tcLoteRps
1-1
Signature
dsig:Signature
0-1
36
Pgina 37 de 42
Reviso 2.02
Nome
EnviarLoteRpsSincronoResposta
Tipo
Pai
Ocorrncia
Observao
1-1
NumeroLote
tsNumeroLote
0-1
DataRecebimento
Datetime
0-1
Protocolo
tsNumeroProtocolo
0-1
ListaNfse
ListaNfse
1-1
CompNfse
CompNfse
1-N
ListaMensagemAlertaRetorno
ListaMensagemAlertaRetorno
0-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
ListaMensagemRetornoLote
ListaMensagemRetornoLote
1-1
Choice
Nome
GerarNfseEnvio
RPS
Tipo
Pai
Ocorrncia
Observao
1-1
tcDeclaracaoPrestacaoServico
1-1
Nome
GerarNfseResposta
ListaNfse
ListaNfse
CompNfse
CompNfse
ListaMensagemAlertaRetorno
ListaMensagemAlertaRetorno
ListaMensagemRetorno
ListaMensagemRetorno
Tipo
Pai
Ocorrncia
Observao
1-1
1-1
0-1
Choice
1-1
37
Pgina 38 de 42
Reviso 2.02
CancelarNfseEnvio
#
Nome
CancelarNfseEnvio
Tipo
Pai
Ocorrncia
Observao
1-1
Pedido
tcPedidoCancelamento
1-1
Nome
CancelarNfseResposta
Tipo
Pai
Ocorrncia
RetCancelamento
tcRetCancelamento
1-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
Observao
Choice
Nome
SubstituirNfseEnvio
SubstituicaoNfse
Tipo
Pai
Ocorrncia
1-1
1-1
Pedido
tcPedidoCancelamento
Rps
tcDeclaracaoPrestacaoServico
Id
tsIdTag
0-1
Signature
dsig:Signature
0-1
Observao
Nome
Tipo
Pai
SubstutuirNfseResposta
RetSubstituicao
NfseSubstituida
Ocorrncia
Observao
1-1
1-1
CompNfse
CompNfse
1-1
ListaMensagemAlertaRetorno
ListaMensagemAlertaRetorno
0-1
NfseSubstituidora
CompNfse
CompNfse
ListaMensagemRetorno
ListaMensagemRetorno
Choice
1-1
1-1
1-1
38
Pgina 39 de 42
Reviso 2.02
Nome
ConsultarLoteRpsEnvio
Tipo
Pai
Ocorrncia
Observao
1-1
Prestador
tcIdentificacaoPrestador
1-1
Protocolo
tsNumeroProtocolo
1-1
Nome
Tipo
Pai
Ocorrncia
ConsultarLoteRpsResposta
Situao
tsSituacaoLoteRps
1-1
ListaNfse
ListaNfse
1-1
CompNfse
CompNfse
1-N
ListaMensagemAlertaRetorno
ListaMensagemAlertaRetorno
0-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
ListaMensagemRetornoLote
ListaMensagemRetornoLote
1-1
Observao
1-1
Choice
Nome
ConsultarNfseRpsEnvio
Tipo
Pai
Ocorrncia
IdentificacaoRps
tcIdentificacaoRps
1-1
Prestador
tcIdentificacaoPrestador
1-1
Observao
Nome
ConsultarNfseRpsResposta
Tipo
Pai
Ocorrncia
CompNfse
CompNfse
1-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
Observao
Choice
2
39
Pgina 40 de 42
Reviso 2.02
Nome
ConsultarNfseEnvio
Tipo
Pai
Ocorrncia
Observao
1-1
Prestador
tcIdentificacaoPrestador
1-1
NumeroNfse
tsNumeroNfse
0-1
0-1
1-1
PeriodoEmissao
DataInicial
date
DataFinal
date
1-1
Choice
PeriodoCompetencia
0-1
1-1
DataInicial
date
DataFinal
date
Tomador
tcIdentificacaoTomador
0-1
Intermediario
tcIdentificacaoIntermediario
0-1
Pagina
tsPagina
1-1
1-1
Nome
ConsultarNfseResposta
ListaNfse
Tipo
Pai
Ocorrncia
Observao
1-1
1
1-1
1-50
CompNfse
CompNfse
Pagina
tsPagina
ListaMensagemRetorno
ListaMensagemRetorno
1-1
Choice
1-1
40
Pgina 41 de 42
Reviso 2.02
ConsultarNfseServicoTomadoEnvio
#
Nome
ConsultarNfseEnvio
Tipo
Pai
Ocorrncia
Observao
1-1
Consulente
tcIdentificacaoConsulente
1-1
NumeroNfse
tsNumeroNfse
0-1
0-1
1-1
PeriodoEmissao
DataInicial
date
DataFinal
date
PeriodoCompetencia
1-1
0-1
1-1
DataInicial
date
DataFinal
date
Prestador
tcIdentificacaoPrestador
0-1
Tomador
tcIdentificacaoTomador
0-1
Intermediario
tcIdentificacaoIntermediario
0-1
Pagina
tsPagina
1-1
Choice
1-1
Nome
ConsultarNfseResposta
ListaNfse
Tipo
Pai
Ocorrncia
Observao
1-1
1
1-1
CompNfse
CompNfse
1-50
Pagina
tsPagina
1-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
Choice
Nome
ConsultarNfseFaixaEnvio
Prestador
Tipo
Pai
Ocorrncia
Observao
1-1
tcIdentificacaoPrestador
Faixa
1-1
0-1
NumeroNfseInicial
tsNumeroNfse
1-1
NumeroNfseFinal
tsNumeroNfse
1-1
Pagina
tsPagina
1-1
41
Pgina 42 de 42
Reviso 2.02
ConsultarNfseFaixaResposta
#
Nome
ConsultarNfseFaixaResposta
ListaNfse
Tipo
Pai
Ocorrncia
Observao
1-1
1
1-1
CompNfse
CompNfse
1-50
Pagina
tsPagina
1-1
ListaMensagemRetorno
ListaMensagemRetorno
1-1
Choice
42