Guia Rápido

Manual Técnico
Serviços Prestados WS
 GUIA RÁPIDO
Serviços Prestados

1- Introdução

Este documento tem como objetivo resumir as principais características e

metodologias dos serviços disponíveis pelo sistema GissOnline para integração de
Notas Fiscais de Serviços Eletrônicas (NFS-e) / Recibos Provisórios de Serviço (RPS).
Não dispensa a leitura dos manuais conceituais e de integração desenvolvidos pela
ABRASF nas versões 2.03 e 2.04, estes manuais seguem disponíveis para download
no site através da área do desenvolvedor.

2- A quem se destina?

Destinado aos desenvolvedores que desejam realizar a integração com a ferramenta

GissOnline para emissão de notas, emissão de notas por RPS, consulta de NFS-e,
consulta de NFS-e por RPS e substituição de notas já emitidas, seja via RPS ou por
número de NFS-e.

3- Descrição do serviço

Os serviços de integração disponibilizados na ferramenta GissOnline consistem na

integração via Web Service SOAP baseados nos modelos ABRASF 2.03 e 2.04, onde
disponibilizamos dois endereços WSDL visando facilitar a integração das ferramentas
utilizadas pelo contribuinte com a administração municipal no que tange a emissão,
substituição, consulta e cancelamento das NFS-e.

Os Web Services estão disponibilizados nos seguintes endereços:

Serviços prestados:

Os links são definidos de acordo com o município, sempre seguindo o seguinte

padrão:
[Link]

Caso o município em questão se chame “Fictício” ou “Demonstração”, logo os

endereços dos WSDL serão os seguintes:

[Link]

[Link]
1
 GUIA RÁPIDO
Serviços Prestados

OBS: Para ter acesso ao WSDL será necessária a apresentação de um certificado

digital valido pela ICP-Brasil, pois será realizado um ‘Handshake’ na abertura do canal
SSL no ato de acesso ao WSDL (Seja via Browser Web ou por aplicação específica).

3.1-Métodos Serviços Prestados

Métodos disponibilizados para que seja feita a integração de notas fiscais de serviços
prestados, sendo emitidas via RPS ou diretamente via NFS-e.

Observação:

• as solicitações de serviços síncronos são processadas imediatamente e o

resultado do processamento é obtido em uma única conexão;
• as solicitações de serviços de assíncronos são processadas de forma
distribuída por vários processos e o resultado do processamento somente é
obtido na segunda conexão;
• os métodos citados neste item são baseados no modelo ABRASF 2.04.

3.1.1- CancelarNfse (síncrono)

Método de cancelamento de NFS-e por número de nota fiscal.

Como retorno, este método deve trazer um arquivo XML com a confirmação de
cancelamento da NFS-e ou uma mensagem de erro (erros de estrutura, dados
incorretos ou substituição em desacordo com a regra definida pela legislação
municipal).

3.1.2- RecepcionarLoteRps (assíncrono)

Método responsável pela recepção dos lotes de recibos provisórios de serviços

limitado a 50 recibos por lote, onde cada recibo provisório presente no lote deve conter
um número de RPS: número de série.

Como retorno, este método deve trazer um XML com o número de protocolo de
recebimento do lote ou um XML contendo um código de erro (erros de estrutura).

2
 GUIA RÁPIDO
Serviços Prestados

3.1.3- ConsultarLoteRps (síncrono)

Método de consulta de lote de recibos provisórios enviados, ele recebe os dados da

empresa juntamente com o número de protocolo retornado pelos métodos
RecepcionarLoteRps ou RecepcionarLoteRpsSincrono.

Como retorno, pode retornar vários elementos de acordo com a condição do

processamento do lote, sendo o primeiro elemento a situação do lote:

1 – Não Recebido: número de protocolo não existe na base de dados, ou lote

não transmitido.

Nestes casos, o retorno será composto pelo elemento Situação com o número
1.

2 – Não Processado: lote pendente de processamento ou na fila de

processamento do processo assíncrono.

Nestes casos, o retorno será composto pelo elemento NumeroLote,

DataRecebimento, Protocolo e Situação com o número 2.

3 – Processado com Erro: lote já processado, porém com erros (sejam de

dados ou de regra legislativa municipal).

Nestes casos o retorno será composto pelos elementos NumeroLote,

DataRecebimento, Protocolo e Situacao com o número 3, e
ListaMensagemRetorno ou ListaMensagemRetornoLote com o(s) código(s)
de erro encontrados na validação do(s) lote(s).

4 – Processado com Sucesso: lote já processado e convertido em NFS-e.

Nestes casos o retorno será composto pelos elementos NumeroLote,

DataRecebimento, Protocolo e Situação com o número 4, juntamente com o
elemento ListaNfse com os dados da(s) nota(s) emitida(s).

3
 GUIA RÁPIDO
Serviços Prestados

3.1.4- ConsultarNfsePorFaixa (síncrono)

Método de consulta de notas emitidas por faixa, permitindo que o usuário realize a
pesquisa de notas fiscais de um número inicial de NFS-e a um número final de NFS-
e já emitidas, incluindo o número da página.

Como resultado, este método deve trazer os dados de até 50 notas fiscais dentro de
um elemento ListaNfse. Caso a quantidade retornada seja maior, o usuário deve
realizar uma nova consulta indicando o número da página requisitada.

Caso algum erro estrutural, cadastral ou de dados informados seja encontrado, o

usuário deve retornar o elemento ListaMensagemRetorno com o(s) devido(s)
código(s) de erro(s).

3.1.5- ConsultarNfsePorRps (síncrono)

Método de consulta de notas emitidas por número de RPS, onde é informado o

Número, Serie e Tipo de um RPS que já fora convertido em NFS-e.

Como retorno, deve trazer o elemento CompNfse e os dados da NFS-e caso ela tenha
obtido sucesso na emissão, ou o elemento ListaMensagemRetorno com o(s)
devido(s) código(s) de erro(s).

3.1.6- ConsultarNfseServicoPrestado (síncrono)

Método de consulta de notas fiscais emitidas, podendo receber 3 diferentes

parâmetros de consulta, sendo: por número de NFS-e(NumeroNfse), por período de
emissão (PeriodoEmissao) ou por período de competência (PeriodoCompetencia).
Podendo indicar também os dados do tomador de serviços e/ou intermediário.

Como existe a possibilidade desta consulta retornar mais de 50 notas fiscais, a

chamada deste método exige o uso do elemento Página em sua requisição.

Como resultado, este método deve trazer os dados de até 50 notas fiscais dentro de
um elemento ListaNfse, caso a quantidade retornada seja maior, o usuário deve
realizar uma nova consulta indicando o número da página requisitada.

4
 GUIA RÁPIDO
Serviços Prestados

Caso algum erro estrutural, cadastral ou de dados informados seja encontrado, o

usuário deve retornar o elemento ListaMensagemRetorno com o(s) devido(s)
código(s) de erro(s).

4- Conexão e Comunicação com o Serviço

4.1 - Padrão de Comunicação

O meio físico de comunicação utilizado entre os sistemas de informação dos

contribuintes e o Sistema de Notas Fiscais de Serviço Eletrônicas das Administrações
Tributárias Municipais será a internet, com o uso do protocolo SSL, que além de
garantir um duto de comunicação seguro na internet, permite a identificação do
servidor e do cliente com a utilização de certificados digitais, eliminando a
necessidade de identificação do usuário com a utilização de nome ou código de
usuário e senha.

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

A troca de mensagens entre o Web Service do sistema de Notas Fiscais de Serviço

Eletrônicas das Administrações Tributárias Municipais e o sistema do contribuinte
será realizada no padrão SOAP, com troca de mensagens XML no padrão
Style/Enconding: Document/Literal, wrapped. A opção “wrapped” representa a
chamada aos métodos disponíveis com a passagem de mais de um parâmetro. Para
descrever os serviços disponibilizados, será utilizado um documento WSDL (Web
Service Description Language). O WSDL é o padrão recomendado para descrição de
serviços SOAP.

SOAP

Requerente Provedor
do Serviço do Serviço

5
 GUIA RÁPIDO
Serviços Prestados

As chamadas aos serviços serão feitas enviando como parâmetro um documento XML
a ser processado pelo sistema. Esse documento não fará parte da descrição do
serviço (arquivo WSDL) e o formato do XML correspondente ao serviço está definido
neste manual de integração.

Observação:

O serviço disponibilizado utiliza como padrão o modelo SOAP 1.0.

4.2 - Padrão de Certificado Digital

Os certificados digitais utilizados no sistema de Notas Fiscais de Serviço

Eletrônicas das Administrações Tributárias Municipais serão emitidos por
Autoridade Certificadora Credenciada pela Infraestrutura de Chaves Públicas
Brasileira – ICP-Brasil, de pessoa física ou jurídica, dos tipos A1 ou A3.

Para a assinatura digital dos documentos envolvidos, aceitar-se-á que o certificado

digital seja de quaisquer dos estabelecimentos da empresa.

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

integração entre o sistema do contribuinte e o Web Service das Administrações
Públicas Municipais:

• Assinatura de Mensagens: O certificado digital utilizado para essa função

deverá conter o CNPJ do estabelecimento emissor da NFS-e ou o CNPJ do
estabelecimento matriz, ou CPF quando o prestador de serviços for pessoa
física. O certificado digital deverá ter o “uso da chave” previsto para a função
de assinatura digital, respeitando a política do certificado.

Durante a transmissão das mensagens entre os servidores do contribuinte e os

serviços disponibilizados pelas Administrações Públicas Municipais, o certificado
digital utilizado para identificação do aplicativo do contribuinte deverá conter o CNPJ
do responsável pela transmissão das mensagens, mas não necessita ser o mesmo
CNPJ do estabelecimento, ou CPF quando o prestador de serviços for pessoa física,
emissor da NFS-e, devendo ter a extensão extended Key Usage com permissão de
"Autenticação Cliente".

6
 GUIA RÁPIDO
Serviços Prestados

Observação:

• o serviço utiliza o padrão TLS 1.2;

• ao utilizar um certificado digital de matriz em uma filial, a raiz do CNPJ (8
primeiros dígitos) devem ser idênticos.

4.3 - Padrão de Assinatura Digital

As mensagens enviadas aos serviços disponibilizados pelas Administrações

Tributárias Municipais são documentos eletrônicos elaborados no padrão XML e
devem ser assinados digitalmente com um certificado digital que contenha o CNPJ
do estabelecimento matriz, o CNPJ do estabelecimento ou o CPF do prestador de
serviços emissor da NFS-e objeto do pedido.

Para garantir minimamente a integridade das informações prestadas e a correta

formação dos arquivos XML, o contribuinte deverá submeter as mensagens XML para
validação pela linguagem de Schema do XML (XSD – XML Schema Definition),
disponibilizada pelas Administrações Tributárias Municipais antes de seu envio.

Os elementos abaixo estão presentes dentro do certificado do contribuinte tornando

desnecessária a sua representação individualizada no arquivo XML. Portanto, o
arquivo XML não deve conter os elementos:

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

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

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

7
 GUIA RÁPIDO
Serviços Prestados

O Projeto NFS-e utiliza um subconjunto do padrão de assinatura XML definido pelo

[Link] que tem o seguinte leiaute:

# Campo Elemento Pai Tipo Ocorrência Descrição

XS01 Signature Raiz

XS02 Id A XS01 C 1-1

XS03 SignedInfo G XS01 1-1 Grupo da Informação da assinatura

XS04 CanonicalizationMethod G XS03 1-1 Grupo do Método de Canonicalização

XS05 Algorithm A XS04 C 1-1 Atributo Algorithm de CanonicalizationMethod:

[Link]
c14n20010315

XS06 SignatureMethod G XS03 1-1 Grupo do Método de Assinatura

XS07 Algorithm A XS06 C 1-1 Atributo Algorithm de SignedInfo:

[Link]

XS08 Reference G XS03 1-1 Grupo do Método de Reference

XS09 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 ser
único

XS12 Transform G XS10 2-2 Grupo de Transform

XS13 Algorithm A XS12 C 1-1 Atributos válidos Algorithm do Transform:

[Link]
20010315
[Link] -
signature
XS14 Xpath E XS12 C 0-N Xpath

XS15 DigestMethod G XS08 1-1 Grupo do Método de DigestMethod

XS16 Algorithm A XS15 C 1-1 Atributo Algorithm de DigestMethod:

[Link]

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

Observação:

Os RPS’s e lote devem ser assinados conforme os seguintes passos:

1. A Assinatura Digital deve seguir o padrão SHA1 seguindo os padrões da W#C

conforme schemas XSD REC-xml-c14n-20010315 e xmldsig#rsa-sha1.
8
 GUIA RÁPIDO
Serviços Prestados

2. Para lotes que contenham mais de um RPS lembre-se de assinar o lote como
um todo, não é necessária a assinatura individual por RPS.

4.4 - Validação de Assinatura Digital pelo Sistema NFS-e

Para a validação da assinatura digital, seguem as regras que serão adotadas pelas
Administrações Tributárias Municipais:

1. Extrair a chave pública do certificado;

2. Verificar o prazo de validade do certificado utilizado;

3. Montar e validar a cadeia de confiança dos certificados validando a LCR (Lista

de Certificados Revogados) de cada certificado da cadeia;

4. Validar o uso da chave utilizada (assinatura digital) de tal forma a aceitar

certificados somente do tipo A (não serão aceitos certificados do tipo S);

5. Garantir que o certificado utilizado é de um usuário final e não de uma

Autoridade Certificadora;

6. Adotar as regras definidas pelo RFC 3280 para LCRs e cadeia de confiança;

7. Validar a integridade de todas as LCRs utilizadas pelo sistema;

8. Verificar data inicial e final do prazo de validade de cada LCR utilizada.

A forma de conferência da LCR fica a critério de cada Administração Tributária

Municipal, podendo ser feita de duas maneiras: on-line ou download periódico. As
assinaturas digitais das mensagens serão verificadas considerando o horário
fornecido pelo Observatório Nacional.

4.5 - Uso de Assinatura com Certificado Digital

Para garantir a autenticidade dos dados gerados, algumas informações poderão ser
assinadas digitalmente conforme determinação da Administração Tributária
Municipal. As informações que poderão ser assinadas e quem deverá fazê-lo em cada
momento são:

9
 GUIA RÁPIDO
Serviços Prestados

• o RPS pelo contribuinte, antes do envio do lote de RPS que o contenha;

• o lote de RPS pelo contribuinte, antes do seu envio;

• a NFS-e pela Administração Tributária Municipal e pelo contribuinte quando

gerada pela Aplicação on-line e pela Administração Tributária Municipal nos
demais casos;

• o pedido de cancelamento da NFS-e pelo contribuinte;

• a confirmação de cancelamento da NFS-e pela Administração Tributária

Municipal;

• a confirmação de substituição da NFS-e pela Administração Tributária

Municipal.

4.6 - Padrão das Mensagens XML

A especificação adotada para as mensagens XML é a recomendação W3C para XML

1.0, disponível em [Link]/TR/REC-xml, e a codificação dos caracteres será em
UTF-8.

As chamadas dos Web Services disponibilizados para as Administrações Tributárias

Municipais e os respectivos resultados do processamento são realizadas com
utilização de mensagens no seguinte padrão:

• Área de Cabeçalho – estrutura XML padrão para todas as mensagens de

chamada e retorno de resultado dos Web Services disponibilizados pelas
Administrações Tributárias Municipais, que contêm os dados de controle da
mensagem. A área de cabeçalho está sendo utilizada para armazenar a versão
do leiaute da estrutura XML informada na área de dados.

• Área de Dados – estrutura XML variável definida na documentação do Web

Service acessado.

10
 GUIA RÁPIDO
Serviços Prestados

4.6.1 - Área do Cabeçalho

Leiaute da Área de Cabeçalho padrão:

# Nome Elemento Pai Tipo Ocorrência Tamanho Descrição

1 cabecalho G 1-1 TAG raiz do cabeçalho da mensagem.

Versão A 1 N 1-1 4 Versão do leiaute.

2 versaoDados E 1 N 1-1 4 O conteúdo deste campo indica a versão

do leiaute XML da estrutura XML
informada na área de dados da
mensagem.

O campo versaoDados deve conter a informação da versão do leiaute da estrutura

XML armazenada na área de dados da mensagem.

A estrutura XML armazenada na área de dados está definida na documentação do

Web Service acessado.

4.6.2 - Validação da Estrutura das Mensagens XML

Para garantir minimamente a integridade das informações

prestadas e a correta formação das mensagens XML, o contribuinte
deverá submeter cada uma das mensagens XML de pedido de
serviço para validação pelo seu respectivo arquivo XSD (XML
Schema Definition, definição de esquemas XML) antes de seu
envio. Neste manual utilizaremos a nomenclatura Schema XML
para nos referir a um arquivo XSD.

Um Schema XML define o conteúdo de uma mensagem XML,

descrevendo os seus atributos, seus elementos e a sua
organização, além de estabelecer regras de preenchimento de conteúdo e de
obrigatoriedade de cada elemento ou grupo de informação.

A validação da estrutura da mensagem XML é realizada por um analisador sintático

(parser) que verifica se a mensagem XML atende às definições e regras de seu
respectivo Schema XML.

Qualquer divergência da estrutura da mensagem XML, em relação ao seu respectivo

Schema XML, provoca um erro de validação do Schema XML. Neste caso, o
conteúdo da mensagem XML de pedido do serviço não poderá ser processado.

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

11
 GUIA RÁPIDO
Serviços Prestados

Assim, os sistemas de informação dos contribuintes devem estar preparados para

gerar mensagens XML em seus respectivos Schemas XML em vigor.

4.6.3 - Schemas XML (arquivos XSD)

O Schema XML (arquivo XSD) correspondente a cada uma das mensagens XML de
pedido e de retorno utilizadas pelo Web Service e pode ser obtido na internet,
acessando o Portal do Sistema de Notas Fiscais de Serviço Eletrônicas das
Administrações Tributárias Municipais.

4.6.4 - Versão dos Schemas XML

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

A identificação da versão dos Schemas XML será realizada com o acréscimo do

número da versão com dois dígitos no nome do arquivo XSD precedida da literal ‘_v’,
como segue:

<Nome do Arquivo>_v<Número da Versão>.xsd

Exemplo:

EnvioLoteRps_v01.xsd

A maioria dos Schemas XML definidos para a utilização do Web Service do Sistema
de Notas Fiscais de Serviço Eletrônicas das Administrações Tributárias Municipais
utilizam as definições de tipos simples ou tipos complexos que estão definidos em
outros Schemas XML. Nesses casos, a modificação de versão do Schema básico
será repercutida no Schema principal.

As modificações de leiaute das mensagens XML do Web Service podem ser

causadas por necessidades técnicas ou em razão da modificação de alguma
legislação. As modificações decorrentes de alteração da legislação deverão ser
implementadas nos prazos previstos no ato normativo que introduziu a alteração. As
modificações de ordem técnica serão divulgadas pelas Administrações Tributárias
Municipais e ocorrerão sempre que se fizerem necessárias.

Observação:

As especificações dos tipos simples e tipos complexos estão descritas no item 6.2
deste manual.

12
 GUIA RÁPIDO
Serviços Prestados

5- Descrição dos Métodos e Funcionalidades Disponíveis

A seguir, estão as especificações de como será a estrutura base dos arquivos XML
de envio e retorno de cada método descrito no item 3 deste manual. Vale ressaltar
que os elementos presentes nos arquivos são representados nessas tabelas por
elementos de tipos simples e elementos de tipos complexos, conforme arquivos XSD
disponibilizados para download na área do desenvolvedor.

As tabelas que detalham cada XML Schema estão divididas da seguinte forma:

(1)

# Nome Tipo Pai Ocorrência Observação

(2) (3) (4) (5) (6) (7)

(8) (9)

Legenda da tabela:

(1) Elemento;

(2) Número identificador do campo, quando este contiver subitens (Elemento Pai);

(3) Nome do campo;

(4) Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo;

(5) Indica qual é o campo pai para definição da hierarquia;

(6) Indica quantas vezes o campo se repete na estrutura de dados:

a. Formato: “Z-Y” onde “Z” é a quantidade mínima e “Y” a quantidade máxima.

Se a quantidade máxima for indefinida, será utilizado “N” no lugar do “Y”, e
caso o elemento não seja de uso obrigatório será utilizado “0” no lugar de
“Z”;

(7) Descreve alguma observação pertinente;

(8) Formato de grupo, utilizado para definição de uma escolha (ver próximo item);

13
 GUIA RÁPIDO
Serviços Prestados

(9) (9) Identifica os campos ou grupos que farão parte de uma escolha (Choice).

5.1 Serviços Prestados

5.1.1 Cancelamento NFS-e

Esse serviço será executado através da chamada ao método CancelarNfse,

passando a mensagem XML como parâmetro com a estrutura definida na tabela que
segue.

CancelarNfseEnvio

# Nome Tipo Pai Ocorrência Observação

1 CancelarNfseEnvio 1-1

Pedido tcPedidoCancelamento 1 1-1

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir

CancelarNfseResposta

# Nome Tipo Pai Ocorrência Observação

1 CancelarNfseResposta

RetCancelamento tcRetCancelamento 1 1-1

Choice
ListaMensagemRetorno ListaMensagemRetorno 1 1-1

5.1.2 Recepção de Lote de RPS

Esse serviço será executado, pelo método RecepcionarLoteRps, passando a

mensagem XML como parâmetro com a estrutura definida na tabela que segue.

EnviarLoteRpsEnvio

# Nome Tipo Pai Ocorrência Observação

1 EnviarLoteRpsEnvio

LoteRps tcLoteRps 1 1-1

Signature dsig:Signature 1 0-1

14
 GUIA RÁPIDO
Serviços Prestados

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir.

EnviarLoteRpsResposta

# Nome Tipo Pai Ocorrência Observação

1 EnviarLoteRpsResposta 1-1

NumeroLote tsNumeroLote 1

DataRecebimento Datetime 1 1-1

Choice
Protocolo tsNumeroProtocolo 1

2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

5.1.3 Consulta de Lote de RPS

Esse serviço será executado pelo método ConsultarLoteRps, passando a

mensagem XML como parâmetro com a estrutura definida na tabela que segue.

ConsultarLoteRpsEnvio

# Nome Tipo Pai Ocorrência Observação

1 ConsultarLoteRpsEnvio 1-1

Prestador tcIdentificacaoPessoaEmpresa 1 1-1

Protocolo tsNumeroProtocolo 1 1-1

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir

ConsultarLoteRpsResposta

# Nome Tipo Pai Ocorrência Observação

1 ConsultarLoteRpsResposta 1-1

2 Situação tsSituacaoLoteRps 1 1-1

3 ListaNfse ListaNfse 1 1-1

CompNfse CompNfse 3 1-N

0-1
ListaMensagemAlertaRetorno ListaMensagemAlertaRetorno 3 Choice

4 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

5 ListaMensagemRetornoLote ListaMensagemRetornoLote 1 1-1

15
 GUIA RÁPIDO
Serviços Prestados

5.1.4 Consulta de NFS-e por Faixa

Esse serviço será executado pelo método ConsultarNfseFaixa, passando a

mensagem XML como parâmetro com a estrutura definida na tabela que segue.

ConsultarNfseFaixaEnvio

# Nome Tipo Pai Ocorrência Observação

1 ConsultarNfseFaixaEnvio 1-1

Prestador tcIdentificacaoPessoaEmpresa 1 1-1

2 Faixa 1 1-1

NumeroNfseInicial tsNumeroNfse 2 1-1

NumeroNfseFinal tsNumeroNfse 2 1-1

3 Página tsPagina 1 1-1

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir

ConsultarNfseFaixaResposta

# Nome Tipo Pai Ocorrência Observação

1 ConsultarNfseFaixaResposta 1-1

2 ListaNfse 1 1-1

CompNfse CompNfse 2 1-50

1-1 Choice
Página tsPagina 2

3 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

5.1.5 Consulta de NFS-e por RPS

Esse serviço será executado pelo método ConsultarNfsePorRps, passando a

mensagem XML como parâmetro com a estrutura definida na tabela que segue.

ConsultarNfseRpsEnvio

# Nome Tipo Pai Ocorrência Observação

1 ConsultarNfseRpsEnvio

IdentificacaoRps tcIdentificacaoRps 1 1-1

Prestador tcIdentificacaoPessoaEmpresa 1 1-1

16
 GUIA RÁPIDO
Serviços Prestados

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir.

ConsultarNfseRpsResposta

# Nome Tipo Pai Ocorrência Observação

1 ConsultarNfseRpsResposta

CompNfse CompNfse 1 1-1

Choice
2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

5.1.6 Consulta de NFS-e – Serviços Prestados

Esse serviço será executado pelo método ConsultarNfseServicoPrestado,

passando a mensagem XML como parâmetro com a estrutura definida na tabela que
segue.

ConsultarNfseServicoPrestadoEnvio

# Nome Tipo Pai Ocorrência Observação

1 ConsultarNfseEnvio 1-1

Prestador tcIdentificacaoPessoaEmpresa 1 1-1

2 NumeroNfse tsNumeroNfse 1 1-1

3 PeriodoEmissao 1 1-1

DataInicial date 3 1-1

1-1
DataFinal date 3 Choice

4 PeriodoCompetencia 1 1-1

DataInicial date 4 1-1

1-1
DataFinal date 4

Tomador tcIdentificacaoPessoaEmpresa 1 0-1

Intermediario tcIdentificacaoPessoaEmpresa 1 0-1

5 Página tsPagina 1 1-1

Em resposta a chamada do serviço, será devolvida a estrutura definida na tabela a

seguir.

ConsultarNfseServicoPrestadoResposta

# Nome Tipo Pai Ocorrência Observação

17
 GUIA RÁPIDO
Serviços Prestados

1 ConsultarNfseResposta 1-1

2 ListaNfse 1 1-1

CompNfse CompNfse 2 1-50

1-1 Choice
Pagina tsPagina 2

3 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

6- Estrutura de Dados

6.1 - Formatos e Padrões Utilizados

Formatações de dados que devem ser seguidas para geração correta na estrutura
dos arquivos:

Formato Observação
Data (date) Formato: AAAA-MM-DD onde:
AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres

Data/Hora (datetime) Formato AAAA-MM-DDTHH:mm:ss onde:

AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres
T = caractere de formatação 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

Não deve ser utilizado separador de milhar. O ponto (.) deve ser utilizado para separar a parte
inteira da fracionária.
Exemplo:
48.562,25 = 48562.25
1,00 = 1.00 ou 1
0,50 = 0.50 ou 0.5
Valores Percentuais (decimal) Formato 00.00
O formato em percentual presume o valor percentual em sua forma fracionária, contendo 5
dígitos. O ponto (.) separa a parte inteira da fracionária. Exemplo:
62% = 62
15% = 15
25,32 = 25.32

Não deve ser inserido caractere não significativo para preencher o tamanho completo
do campo, ou seja, zeros antes de número ou espaço em branco após a cadeia de
caracteres. A posição do campo é definida na estrutura do documento XML através
de TAGs (<tag>conteúdo</tag>).

18
 GUIA RÁPIDO
Serviços Prestados

A regra constante do parágrafo anterior deverá estender-se para os campos nos quais
não há indicação de obrigatoriedade e que, no entanto, seu preenchimento torna-se
obrigatório devido à legislação específica ou ao negócio do contribuinte. Nesse caso,
deverá constar a TAG com o valor correspondente e, para os demais campos,
deverão ser eliminadas as TAGs.

Para reduzir o tamanho final do arquivo XML da NFS-e alguns cuidados de

programação deverão ser assumidos:

• não incluir "zeros não significativos" para campos numéricos;

• não incluir "espaços" no início ou no final de campos numéricos e

alfanuméricos;

• não incluir comentários no arquivo XML;

• não incluir anotação e documentação no arquivo XML (TAG annotation e TAG

documentation);

• não incluir caracteres de formatação no arquivo XML ("line-feed", "carriage

return", "tab", caractere de "espaço" entre as TAGs);

• para quebra de linha na exibição para os campos contendo caracteres

Discriminação e Outras informações, utilizar a sequência “\s\n”.

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

6.2 – Tipos Simples e Tipos Complexos

Por definição um XML SCHEMA considera como um elemento de tipo simples um

elemento qualquer que não possua atributos em suas definições e, naturalmente,
deve receber apenas um texto com um tipo de dado definido (Ex: Character, Date,
Number etc.).

19
 GUIA RÁPIDO
Serviços Prestados

Um elemento de tipo complexo, por sua vez, é caracterizado por receber tanto
atributos quanto outros subelementos em seu conteúdo.

Neste manual iremos dividir as definições de tipos simples e complexos em duas

partes (Serviços Prestados e Serviços Comprados).

6.2.1 Tipos Simples Serviços Prestados

A seguir, encontra-se a tabela com a lista dos tipos simples que serão utilizados como
tipos de dados. A tabela está dividida em 4 colunas.

• Campo - nome do tipo simples;

• Tipo - tipo primitivo de dados utilizados pelo campo;

C - Caractere

N - Número

D - Data ou Data/Hora

T - Token

• Descrição - descreve informações sobre o campo;

Tam. - tamanho do campo

Quando forem caracteres o tamanho define a quantidade máxima de

caracteres que o texto poderá ter

Quando for numérico o tamanho pode ser representado das seguintes

formas:

▪ Número inteiro, que define o total de dígitos existente no número.

Exemplo: “15” significa que o número poderá ter, no máximo, 15
dígitos.

▪ Número fracionário, que define o total de dígitos e quantos deles

serão designados para a parte fracionária. Exemplo: “15,2”

20
 GUIA RÁPIDO
Serviços Prestados

significa que o número poderá ter, no máximo, 15 dígitos sendo

2 deles a da parte fracionária. A parte fracionária não é
obrigatória quando assim definido.

Quando for data, não haverá definição de tamanho.

Campo Tipo Descrição Tam.

tsNumeroNfse N Número da Nota Fiscal de Serviço Eletrônica, formado por 15
um número sequencial com 15 posições

tsCodigoVerificacao C Código de verificação do número da nota 9

tsNif C Número de Identificação Fiscal: 40

tsStatusRps N Código de status do RPS 1

1 – Normal
2 – Cancelado
tsStatusNfse N Código de status da NFS-e 1
1 – Normal
2 – Cancelado

Campo Tipo Descrição Tam.

tsExigibilidadeIss N Código de natureza da operação 2

1 – Exigível;
2 – Não incidência;
3 – Isenção;
4 – Exportação;
5 – Imunidade;
6 – Exigibilidade Suspensa por Decisão Judicial;
7 – Exigibilidade Suspensa por Processo Administrativo

tsIdentifNaoExigibilidade C Identificação da não exigibilidade do ISSQN – somente para 4

os casos de benefício fiscal
tsNumeroProcesso C Número do processo judicial ou administrativo de 30
suspensão da exigibilidade

tsRegimeEspecialTributacao N Código de identificação do regime especial de tributação 2

1 – Microempresa municipal
2 – Estimativa
3 – Sociedade de profissionais
4 – Cooperativa
5 – Microempresário Individual (MEI)
6 – Microempresa ou Empresa de Pequeno Porte (ME EPP)

tsSimNao N Identificação de Sim/Não 1

1 – Sim
2 – Não

tsResponsavelRetencao N Identificação do responsável pela retenção do ISS 1

1 – Tomador
2 – Intermediário

tsPagina N Número da página da consulta 6

tsNumeroRps N Número do RPS 15

21
 GUIA RÁPIDO
Serviços Prestados

tsSerieRps C Número de série do RPS 5

tsTipoRps N Código de tipo de RPS 1

1 – RPS
2 – Nota Fiscal Conjugada (Mista)
3 – Cupom
tsOutrasInformacoes C Informações adicionais ao documento. 510

tsValor N Valor monetário. 15,2

Formato: 0.00 (ponto separando casa decimal)
Ex: 1.234,56 = 1234.56
1.000,00 = 1000.00
1.000,00 = 1000
tsItemListaServico C Subitem do serviço prestado conforme LC 116/2003 5

tsCodigoCnae N Código CNAE 7

tsCodigoTributacao C Código de Tributação 20

tsDescricaoCodigoTributacaoMunicípio C Descrição do código de tributação do município. 1000

tsCodigoNbs C Código de NBS 9

tsAliquota N Alíquota. Valor percentual. 4,2

Formato: 00.00
Ex: 1% = 1
25,5% = 25.5
10% = 10
tsDiscriminacao C Discriminação do conteúdo da NFS-e 2000

Campo Tipo Descrição Tam.

tsCodigoMunicipioIbge N Código de identificação do município conforme tabela do 7
IBGE

tsInscricaoMunicipal C Número de inscrição municipal 15

tsRazaoSocial C Razão Social do contribuinte 150

tsNomeFantasia C Nome fantasia 60

tsCNPJ C Número CNPJ 14

tsEndereco C Tipo e nome do logradouro (Av.., Rua..., ...) 255

tsNumeroEndereco C Número do imóvel 60

tsComplementoEndereco C Complemento de endereço 60

tsBairro C Bairro 60

tsUf C Sigla da unidade federativa 2

tsCodigoPaisIbge C Código de identificação do município conforme tabela de 4

país do IBGE

Número do CEP
tsCep C Formato: [0-9]{8} 8

tsEmail C E-mail 80

tsTelefone C Telefone 20

22
 GUIA RÁPIDO
Serviços Prestados

tsCPF C Número de CPF 11

tsCodigoObra C Código de Obra 30

tsArt C Código ART 30

tsIdentificacaoEvento C Identificação do evento 30

tsDescricaoEvento C Descrição do evento 255

tsInformacoesComplementares C Informações complementares para uso do prestador de 2000

serviços conforme regulamento do município,
preenchido no padrão JSON

tsNumeroLote N Número do Lote de RPS 15

tsNumeroProtocolo C Número do protocolo de recebimento do lote RPS 50

tsSituacaoLoteRps N Código de situação de lote de RPS 1

1– Não Recebido
2– Não Processado
3– Processado com Erro
4– Processado com Sucesso
tsQuantidadeRps N Quantidade de RPS do Lote 4

tsCodigoMensagemAlerta C Código de mensagem de retorno de serviço. 4

tsDescricaoMensagemAlerta C Descrição da mensagem de retorno de serviço. 200

tsCodigoCancelamentoNfse C Código de ca encelamento com base na tabela de Erros 4

alertas.
1– Erro na emissão
2– Serviço não prestado
3– Erro de assinatura
4– Duplicidade da nota
5– Erro de processamento
Importante: Os códigos 3 (Erro de assinatura) e 5
(Erro de processamento) são de uso restrito da
Administração Tributária Municipal
tsIdTag C Atributo de identificação da tag a ser assinada no 255
documento XML

Campo Tipo Descrição Tam.

tsVersao T Versão do leiaute.
Formato: [1-9]{1}[0-9]{0,1}\.[0-9]{2}

tsTipoDeducao N Código de identificação do tipo da dedução 2

1 – Materiais;
2 – Subempreitada de mão de obra;
3 – Serviços;
4 – Produção externa;
5 – Alimentação e bebidas/frigobar;
6 – Reembolso de despesas;
7 – Repasse consorciado;
8 – Repasse plano de saúde;
99 – Outras deduções
tsDescricaoDeducao C Descrição do tipo da dedução, caso ela não seja 150
autoexplicativa, como “Outras deduções”
tsNumeroNfe N Número da NF-e 9

tsChaveAcessoNfe N Chave de acesso da NF-e 44

tsIdentificacaoDocumento C Identificação e descrição de documento 255

23
 GUIA RÁPIDO
Serviços Prestados

tsEnderecoCompletoExterior C Descrição do endereço do exterior 255

6.2.2 – Tipos Complexos Serviços Prestados

A seguir, são detalhadas as tabelas de cada tipo composto e seus campos. A tabela
está dividida da seguinte forma:

(1)

(2)

Nome Tipo Ocorrência Descrição

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

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

Legenda da tabela:

(1) Nome do tipo complexo;

(2) Descrição do tipo complexo;

(3) Identifica se a sequência 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 simples ou complexo;

(6) Quantas vezes o campo se repete na estrutura de dados:

a. Formato: “Z-Y” onde “Z” é a quantidade mínima e “Y” a quantidade máxima.

Se a quantidade máxima for indefinida, será utilizado “N” no lugar do “Y”, e
caso o elemento não seja de uso obrigatório, será utilizado “0” no lugar de
“Z”;

(7) Descrição do campo.

tcCPFCNPJ

Número de CPF ou CNPJ

24
 GUIA RÁPIDO
Serviços Prestados

Nome Tipo Ocorrência Descrição

CPF tsCPF 1-1 Número do CPF

Choice
CNPJ tsCNPJ 1-1 Número do CNPJ

tcEndereco
Representação completa do endereço

Nome Tipo Ocorrência Descrição

Endereco tsEndereco 1-1 Tipo e nome do logradouro

Numero tsNumeroEndereco 1-1 Número do imóvel

Complemento tsComplementoEndereco 0-1 Complemento do Endereço

Bairro tsBairro 1-1 Nome do bairro

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Código da cidade

Uf tsUf 1-1 Sigla do estado

Cep tsCep 1-1 CEP da localidade

tcEnderecoExterior
Representação completa do endereço

Nome Tipo Ocorrência Descrição

CodigoPais tsCodigoPaisIbge 1-1 Código do país da tabela de

país do IBGE

EnderecoCompletoExterior tsEnderecoCompletoExterior 1-1 Descrição do endereço

tcContato
Representa forma de contato com a pessoa (física/jurídica)

Nome Tipo Ocorrência Descrição

Telefone tsTelefone tsEmail 1-1 Número do telefone

Choice Email 0-1 Endereço eletrônico (email)
1-1
Email tsEmail 1-1 Endereço eletrônico (email)

tcIdentificacaoOrgaoGerador

Representa dados para identificação de órgão gerador

Nome Tipo Ocorrência Descrição

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Código da cidade

Uf tsUf 1-1 Sigla do estado

25
 GUIA RÁPIDO
Serviços Prestados

tcIdentificacaoRps
Dados de identificação do RPS

Nome Tipo Ocorrência Descrição

Numero tsNumeroRps 1-1 Número do RPS

Serie tsSerieRps 1-1 Série do RPS

Tipo tsTipoRps 1-1 Tipo do RPS

tcIdentificacaoPessoaEmpresa
Representa dados para identificação do prestador de serviço

Nome Tipo Ocorrência Descrição

CPFCNPJ tcCPFCNPJ 1-1 CPF ou CNPJ da

empresa/pessoa

InscricaoMunicipal tsInscricaoMunicipal 0-1 Inscrição Municipal da

empresa/pessoa

tcDadosTomador

Representa dados do tomador de serviço

Nome Tipo Ocorrência Descrição

IdentificacaoTomador tcIdentificacaoPessoaEmpresa 0-1 CPF ou CNPJ e Inscrição

Municipal do tomador do
serviços

NifTomador tsNif 0-1 NIF do tomador do serviço, se

do exterior

RazaoSocial tsRazaoSocial 1-1 Razão Social do tomador do

serviço

Endereco tcEndereco 1-1 Endereço de tomador de

serviços do Brasil
Choice
EnderecoExterior tcEnderecoExterior 1-1 Endereço de tomador de
serviços do exterior

Contato tcContato 0-1

tcDadosIntermediario

Representa dados para identificação de intermediário do serviço

Nome Tipo Ocorrência Descrição

IdentificacaoIntermediario tcIdentificacaoPessoaEmpresa 1-1 CPF ou CNPJ do

intermediário do serviço

RazaoSocial tsRazaoSocial 1-1 Inscrição Municipal do

intermediário do serviços

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Código da cidade

26
 GUIA RÁPIDO
Serviços Prestados

tcValoresDeclaracaoServico
Representa um conjunto de valores que compõe a declaração do serviço

Nome Tipo Ocorrência Descrição

ValorServicos tsValor 1-1 Valor do serviço

ValorDeducoes tsValor 0-1 Valor total das deduções

ValorPis tsValor 0-1 Valor do PIS

ValorCofins tsValor 0-1 Valor do CONFINS

ValorInss tsValor 0-1 Valor do INSS

ValorIr tsValor 0-1 Valor do imposto de renda

ValorCsll tsValor 0-1 Valor do CSLL

OutrasRetencoes tsValor 0-1 Valor total de outras retenções

ValTotTributos tsValor 0-1 Valor total de tributos

ValorIss tsValor 0-1 Valor do ISS quando informado

pelo prestador

Aliquota tsAliquota 0-1 Alíquota do ISS quando

informado pelo prestador

DescontoIncondicionado tsValor 0-1 Valor do desconto

condicionado

DescontoCondicionado tsValor 0-1 Valor do desconto

incondicionado

tcValoresNfse
Representa um conjunto de valores que compõe o documento fiscal

Nome Tipo Ocorrência Descrição

BaseCalculo tsValor 1-1 (Valor dos serviços – Valor das

deduções – descontos
incondicionados)

Aliquota tsAliquota 0-1 Alíquota do ISS quando

informado pelo município

ValorIss tsValor 0-1 Valor do ISS quando informado

pelo município

ValorLiquidoNfse tsValor 1-1 (ValorServicos – ValorPIS –

ValorCOFINS – ValorINSS
– ValorIR – ValorCSLL –
OutrasRetençoes –
ValorISS (se imposto
retido) –
DescontoIncondicionado –
DescontoCondicionado)

tcDadosServico

27
 GUIA RÁPIDO
Serviços Prestados

Representa dados que compõe o serviço prestado

Nome Tipo Ocorrência Descrição

Valores tcValoresDeclaracaoServico 1-1 Valor do serviço

IssRetido tsSimNao 1-1 ISS retido (S/N)

ResponsavelRetencao tsResponsavelRetencao 0-1 Responsável pela retenção

ItemListaServico tsItemListaServico 1-1 Subitem do serviço prestado

CodigoCnae tsCodigoCnae 0-1 Código CNAE

CodigoTributacaoMunicipio tsCodigoTributacao 0-1 Código de tributação do

município

CodigoNbs tsCodigoNbs 0-1 Código de NBS do serviço

Discriminacao tsDiscriminacao 1-1 Discriminação do serviço

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Código do município da

prestação do serviço

CodigoPais tsCodigoPaisIbge 0-1 Código do país

ExigibilidadeISS tsExigibilidadeISS 1-1 Exigibilidade do ISS

IdentifNaoExigibilidade tsIdentifNaoExigibilidade 0-1 Identificação da não

exigibilidade

MunicipioIncidencia tsCodigoMunicipioIbge 0-1 Município da incidência do ISS

NumeroProcesso tsNumeroProcesso 0-1 Número do processo da

suspensão da exigibilidade

tcDadosConstrucaoCivil
Representa dados para identificação de obra de engenharia e arquitetura em geral

Nome Tipo Ocorrência Descrição

CodigoObra tsCodigoObra 1-1 Número de identificação da

obra
Choice
Art tsArt 0-1 Número da ART
1-1
Art tsArt 1-1 Número da ART

tcEvento
Representa dados para identificação do evento

Nome Tipo Ocorrência Descrição

IdentificacaoEvento tsIdentificacaoEvento tsDescricaoEvento 1-1 Identificação do evento

Choice DescricaoEvento 0-1 Descrição do evento
1-1
DescricaoEvento tsDescricaoEvento 1-1 Descrição do evento

28
 GUIA RÁPIDO
Serviços Prestados

tcDadosPrestador
Representa dados do prestador do serviço

Nome Tipo Ocorrência Descrição

RazaoSocial tsRazaoSocial 1-1 Razão social do prestador

NomeFantasia tsNomeFantasia 0-1 Nome fantasia do prestador

Endereco tcEndereco 1-1 Endereço do prestador

Contato tcContato 0-1 Contatos do prestador

tcIdentificacaoNfseDeducao

Representa dados para identificação do NFS-e de dedução

Nome Tipo Ocorrência Descrição

CodigoMunicipioGerador tsCodigoMunicipioIbge 1-1 Município de geração da NFS-e

NumeroNfse tsNumeroNfse 1-1 Número da NFS-e

CodigoVerificacao tsCodigoVerificacao 0-1 Código de verificação da NFS-e

tcIdentificacaoNfeDeducao

Representa dados para identificação da NF-e de dedução

Nome Tipo Ocorrência Descrição

NumeroNfe tsNumeroNfe 1-1 Número da NF-e

UfNfe tsUf 1-1 Estado de geração da NF-e

ChaveAcessoNfe tsChaveAcessoNfe 0-1 Chave da NF-e

tcOutroDocumentoDeducao
Representa dados para identificação de
diferente de nota fiscal eletrônica

Nome Tipo Ocorrência Descrição

IdentificacaoDocumento tsIdentificacaoDocumento 1-1 Identificação de documento

diferente de NFS-e e NF-e

29
 GUIA RÁPIDO
Serviços Prestados

tcIdentificacaoDocumentoDeducao
Representa dados do documento da dedução do serviço prestado

Nome Tipo Ocorrência Descrição

IdentificacaoNfse tcIdentificacaoNfseDeducao 1-1 Se o documento for NFS-e

IdentificacaoNFe tcIdentificacaoNfeDeducao 1-1 Se o documento for NF-e

Choice
OutroDocumento tcOutroDocumentoDeducao 1-1 Se o documento não for as
duas opções anteriores

tcIdentificacaoFornecedor

Representa dados para identificação do fornecedor do Brasil

Nome Tipo Ocorrência Descrição

CPFCNPJ tcCPFCNPJ 1-1 CNPJ ou CPF do fornecedor do

Brasil

tcFornecedorExterior
Representa dados para identificação do fornecedor do exterior

Nome Tipo Ocorrência Descrição

NifFornecedor tsNif 0-1 NIF do fornecedor do exterior

CodigoPais tsCodigoPaisIbge 1-1 Código do país do fornecedor

do exterior

tcDadosFornecedor
Representa dados do fornecedor do exterior

Nome Tipo Ocorrência Descrição

IdentificacaoFornecedor tcIdentificacaoFornecedor 1-1 Identificação do fornecedor do

Brasil
Choice
FornecedorExterior tcFornecedorExterior 1-1 Identificação do fornecedor do
exterior

tcDadosDeducao
Representa dados da dedução do serviço prestado

Nome Tipo Ocorrência Descrição

TipoDeducao tsTipoDeducao 1-1 Tipo da dedução

DescricaoDeducao tsDescricaoDeducao 0-1 Obrigatório para TipoDeducao

igual a “99 – Outras deduções”

30
 GUIA RÁPIDO
Serviços Prestados

IdentificacaoDocumentoDeducao tcIdentificacaoDocumentoDeducao 1-1 Identificação do documento

de dedução

DadosFornecedor tcDadosFornecedor 1-1 Dados do fornecedor

DataEmissao Date 1-1 Data de emissão do

documento fiscal

ValorDedutivel tsValor 1-1 Valor dedutível do documento

fiscal

ValorUtilizadoDeducao tsValor 1-1 Valor utilizado na dedução da

NFS-e

tcInfRps

Representa dados informativos do Recibo Provisório de Serviço (RPS)

Nome Tipo Ocorrência Descrição

IdentificacaoRps tcIdentificacaoRps 0-1 Número do RPS

(Obrigatório somente se
declaração do prestador)

DataEmissao Date 1-1 Data de emissão do RPS

Status tsStatusRps 1-1 Situação do RPS

RpsSubstituido tcIdentificacaoRps 0-1 RPS substituído (válido se RPS

ainda não estiver convertido
em NFS-e)

Id tsIdTag Identificador da TAG a ser

assinada

tcInfDeclaracaoPrestacaoServico

Representa dados do da declaração do prestador do serviço

Nome Tipo Ocorrência Descrição

Rps tcInfRps 0-1 Informações do RPS

(número, série, tipo, data de
emissão e status do RPS)

Competencia Date 1-1 Data da competência do

serviço

Servico tcDadosServico 1-1 Dados do serviço prestado

Prestador tcIdentificacaoPessoaEmpresa 1-1 Identificação do prestador do

serviço

TomadorServico tcDadosTomador 0-1 Dados do tomador do serviço

Intermediario tcDadosIntermediario 0-1 Dados do intermediário

ConstrucaoCivil tcDadosConstrucaoCivil 0-1 Dados da obra

RegimeEspecialTributacao tsRegimeEspecialTributacao 0-1 Identificação do regime

especial de tributação

31
 GUIA RÁPIDO
Serviços Prestados

OptanteSimplesNacional tsSimNao 1-1 Informação se optante pelo

Simples Nacional (S/N)

IncentivoFiscal tsSimNao 1-1 Informação se o prestador é

incentivador fiscal

Evento tcEvento 0-1 Informação do evento

InformacoesComplementares tsInformacoesComplementares 0-1 Informações

complementares solicitadas
pelo município

Deducao tcDadosDeducao 0-N Dados da dedução

Id tsIdTag Identificador da TAG a ser

assinada

tcDeclaracaoPrestacaoServico
Representa a estrutura da declaração da prestação do serviço assinada

Nome Tipo Ocorrência Descrição

InfDeclaracaoPrestacaoServico tcInfDeclaracaoPrestacaoServico 1-1 Declaração do serviço

prestado

Signature dsig:Signature 0-1 Assinatura digital do prestador

ou procurador

tcIdentificacaoNfse

Representa dados que identificam uma Nota Fiscal de Serviços Eletrônica

Nome Tipo Ocorrência Descrição

Numero tsNumeroNfse 1-1 Número da NFS-e

CPFCNPJ tcCPFCNPJ 1-1 CNPJ ou CPF do prestador do

serviço

InscricaoMunicipal tsInscricaoMunicipal 0-1 Inscrição Municipal do

prestador do serviço

CodigoMunicipio tsCodigoMunicipioIbge 1-1 Código do município da

geração da NFS-e

tcInfNfse

Representa os dados informativos da Nota Fiscal de Serviços Eletrônica

Nome Tipo Ocorrência Descrição

Numero tsNumeroNfse 1-1 Número da NFS-e

CodigoVerificacao tsCodigoVerificacao 1-1 Código de verificação da NFS-e

DataEmissao Datetime 1-1 Data de emissão da NFS-e

NfseSubstituida tsNumeroNfse 0-1 Número da NFS-e substituída

pela NFS-e

32
 GUIA RÁPIDO
Serviços Prestados

OutrasInformacoes tsOutrasInformacoes 0-1 Outras informações

(preenchido pelo município)

ValoresNfse tcValoresNfse 1-1 Valores da NFS-e

DescricaoCodigoTributacaoMunicípio tsDescricaoCodigoTributacaoMunicípio 0-1 Descrição do código de

tributação do município

ValorCredito tsValor 0-1 Valor do crédito gerado pela

NFS-e

PrestadorServico tcDadosPrestador 1-1 Dados do prestador do

serviços

OrgaoGerador tcIdentificacaoOrgaoGerador 1-1 Órgão gerador da NFS-e

DeclaracaoPrestacaoServico tcDeclaracaoPrestacaoServico 1-1 Dentro dessa estrutura está

o RPS, como não obrigatório

Id tsIdTag Identificador da TAG a ser

assinada

tcNfse

Representa a estrutura da Nota Fiscal de Serviços Eletrônica assinada

Nome Tipo Ocorrência Descrição

InfNfse tcInfNfse 1-1 Dados da NFS-e

Signature Dsig:Signature 0-1 Assinatura digital do município

versao tsVersao 1-1

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota Fiscal de Serviços Eletrônica.

Nome Tipo Ocorrência Descrição

IdentificacaoNfse tcIdentificacaoNfse 1-1 Identificação da NFS-e a ser

cancelada

CodigoCancelamento tsCodigoCancelamentoNfse 1-1 Código do cancelamento

Id tsIdTag Identificador da TAG a ser

assinada

tcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Serviços Eletrônica assinada

Nome Tipo Ocorrência Descrição

InfPedidoCancelamento tcInfPedidoCancelamento 1-1 Dados do pedido do

cancelamento da NFS-e

Signature Dsig:Signature 0-1 Assinatura digital do prestador

ou procurador

33
 GUIA RÁPIDO
Serviços Prestados

tcConfirmacaoCancelamento

Representa a estrutura de Confirmação de Cancelamento da Nota Fiscal de Serviços Eletrônica assinada

Nome Tipo Ocorrência Descrição

Pedido tcPedidoCancelamento 1-1 Pedido de cancelamento da

NFS-e

DataHora datetime 1-1 Data e hora do cancelamento

Id tsIdTag Identificador da TAG a ser

assinada

tcCancelamentoNfse
Representa a estrutura completa (pedido + confirmação) de cancelamento de NFS-e

Nome Tipo Ocorrência Descrição

Confirmacao tcConfirmacaoCancelamento 1-1 Confirmação do cancelamento

Signature Dsig:Signature 0-1 Assinatura digital do município

versao tsVersao 1-1

tcRetCancelamento
Representa a estrutura de Confirmação de Cancelamento da Nota Fiscal de Serviços Eletrônica assinada

Nome Tipo Ocorrência Descrição

NfseCancelamento tcCancelamentoNfse 1-1 Retorno do cancelamento da

NFS-e

tcInfSubstituicaoNfse

Representa os dados de registro de substituição de NFS-e.

Nome Tipo Ocorrência Descrição

NfseSubstituidora tsNumeroNfse 1-1 Número da NFS-e que

substituidora

Id tsIdTag Identificador da TAG a ser

assinada

tcSubstituicaoNfse
Representa a estrutura de substituição de NFS-e.

SubstituicaoNfse tcInfSubstituicaoNfse 1-1 Número da NFS-e que é a

substituidora

34
 GUIA RÁPIDO
Serviços Prestados

Signature dsig:Signature 0-2 Assinatura do prestador ou

procurador e assinatura do
município

versao tsVersao 1-1 versao

tcCompNfse

Representa a estrutura de compartilhamento de dados de uma NFS-e.

Nome Tipo Ocorrência Descrição

Nfse tcNfse 1-1 Dados da NFS-e

NfseCancelamento tcCancelamentoNfse 0-1 Dados do cancelamento

NfseSubstituicao tcSubstituicaoNfse 0-1 Dados da substituição

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de serviço.

Nome Tipo Ocorrência Descrição

Codigo tsCodigoMensagemAlerta 1-1 Código da mensagem de

alerta

Mensagem tsDescricaoMensagemAlerta 1-1 Descrição da mensagem de

alerta

Correcao tsDescricaoMensagemAlerta 0-1 Descrição dos procedimentos

para a correção da NFS-e

tcMensagemRetornoLote

Representa a estrutura de mensagem de retorno de serviço.

Nome Tipo Ocorrência Descrição

IdentificacaoRps tcIdentificacaoRps 1-1 Identificação do RPS

Codigo tsCodigoMensagemAlerta 1-1 Código da mensagem de

erro

Mensagem tsDescricaoMensagemAlerta 1-1 Descrição da mensagem do

erro

tcLoteRps

Representa a estrutura do lote de RPS para fila de processamento

Nome Tipo Ocorrência Descrição

NumeroLote tsNumeroLote 1-1 Número do lote informado

pelo prestador

35
 GUIA RÁPIDO
Serviços Prestados

Prestador tcIdentificacaoPessoaEmpresa 1-1 CNPJ ou CPF do prestador /

Inscrição municipal do
prestador

QuantidadeRps tsQuantidadeRps 1-1 Quantidade de RPS contidas

no lote

ListaRps 1-1 Lista de RPS

Rps tcDeclaracaoPrestacaoServico 1-N Dados dos RPSs

Id tsIdTag Identificador da TAG a ser

assinada

versao tsVersao 1-1

ListaMensagemRetornoLote

Representa a estrutura de mensagem de retorno de serviço.

Nome Tipo Ocorrência Descrição

MensagemRetorno tcMensagemRetornoLote 1-N Mensagens de retorno do lote

ListaMensagemRetorno

Representa a estrutura de mensagem de retorno de serviço.

Nome Tipo Ocorrência Descrição

MensagemRetorno tcMensagemRetorno 1-N Mensagens de retorno do lote

ListaMensagemAlertaRetorno

Representa a estrutura de mensagem de retorno de serviço.

Nome Tipo Ocorrência Descrição

MensagemRetorno tcMensagemRetorno 1-N Mensagens de erros e alertas

cabecalho

Representa a estrutura do cabeçalho

Nome Tipo Ocorrência Descrição

versaoDados tsVersao 1-1

versao tsVersao

36
 GUIA RÁPIDO
Serviços Prestados

CompNfse

Representa a estrutura da NFS-e.

Nome Tipo Ocorrência Descrição

CompNfse tcCompNfse 1-1

37