Documente Academic
Documente Profesional
Documente Cultură
Manual de Integrao
Verso 1.2.1.1
Layout 2.0
(Especificao Tcnica de Integrao entre Sistema do Contribuinte e Cliente NFPS-e)
FLORIANPOLIS - SC
Sumrio
Controle de Alteraes....................................................................................................................
1.Introduo.....................................................................................................................................
2.Modelo Operacional.....................................................................................................................
3.Padro de Mensagens XML........................................................................................................
3.1.Validao da estrutura das Mensagens XML.............................................................................................7
4.Tipos Utilizados............................................................................................................................
4.1.Formatos e Padres Utilizados..................................................................................................................9
4.2.Tipos Simples...........................................................................................................................................10
4.3.Tipos Complexos......................................................................................................................................14
Controle de Alteraes
Verso Layout
(XSD)
1.0
2.0
Data de Liberao
Alteraes
Novembro/2011
Fevereiro/2013
Primeira verso
- Atualizao do targetNamespace para a
verso 2.0 (conforme exemplo da pgina 28)
- Substituio do elemento Signature pelo
novo elemento Protocolo, pgina 17
- Novo elemento DataProcessamento,
conforme pgina 17
- Alterao do elemento DataCancelamento
de Date para Datetime, conforme pgina 17
- Incluso da funcionalidade de requisio
de cancelamento de NFPS-e.
- Descrio da funcionalidade de multiemails.
Abril/2015
Julho/2015
1. Introduo
Considera-se Nota Fiscal de Prestao de Servio Eletrnica, NFPS-e o
documento eletrnico gerado e emitido pela Secretaria Municipal da Receita
SMR para documentar prestaes de servios, de existncia exclusivamente
digital, fornecido mediante requisio enviada pelo contribuinte.
A NFPS-e poder ser utilizada por contribuinte do Imposto Sobre Servios de
Qualquer Natureza ISQN , em substituio Nota Fiscal de Prestao de
Servio modelo I.
O contribuinte que optar por emitir e conservar os seus documentos fiscais, na
forma prevista nesta Subseo, dever:
I.
II.
III.
2. Modelo Operacional
O mdulo cliente (Cliente NFPS-e) um software instalado no computador do
contribuinte que deseja utilizar os servios do sistema de gerao e emisso de
Nota Fiscal de Prestao de Servios Eletrnica NFPS-e da Secretaria Municipal
de Receita SMR de Florianpolis. O Cliente NFPS-e tem as seguintes
funcionalidades:
Cancela/Substitui NFPS-e;
Consulta de NFPS-e;
Exportao de NFPS-e;
O Cliente NFPS-e pode trabalhar de forma integrada com software ERP desde
que este gere uma Requisio para emisso de NFPS-e no formato XML
(tcRequisicao) definido pela SMR. Caso o usurio no possua sistema ERP que
4. Tipos Utilizados
A seguir so apresentados os formatos e padres, tipos simples e complexos
utilizados nos Schemas XML de requisio e NFPS-e. Estes tipos esto definidos
no Schema XML de TiposNFPS-e (arquivo TiposNFPSe_V2_0.xsd).
Para obter a verso mais recente do Schema XML de TiposNFPS-e (bem
como os demais Schemas XML) acesse o link:
http://nfe.pmf.sc.gov.br/nfse/versao?tipo=SCHEMAS.
Formato
Observao
Data (date)
Formato: AAAA-MM-DD
onde:
AAAA = ano com 4 caracteres
MM = ms com 2 caracteres
DD = dia com 2 caracteres
Formato AAAA-MM-DDTHH:mm:ss.ccc
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
ccc: milisegundos com 3 caracteres
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
Formato 0.0000
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
O formato base64 utilizado para codificao de dados binrios.
Exemplo:
<Protocolo Id="PDDE-070201240050001_9407746">
TUlJSzdqQURBZ0VBTUlJSzVRWUpLb1pJaHZjAjKuyGFpsDa2UpQlJ
...
VIUnU2dURGOEw3OFpDa2UySmg1VkcvVDNWTEFPdUkreE45WQ==
</Protocolo>
Data/Hora (datetime)
Valores Decimais
(decimal)
Valores Percentuais
(decimal)
Base64
B: Binrio;
C: Caractere;
N: Nmero;
Nome do Tipo
tsIdTag
Descrio
(Tipo utilizado para
informar ...)
Atributo identificador da tag a ser
assinada no documento XML.
Tipo
Base
Tamanho
23
Observao
tsNumeroAEDF
tsTipoAEDF
Tipo da AEDF
Tipos de AEDF:
NORMAL (NFPS)
FATURA (NFPS-F)
tsAutenticacao
40
tsAliquota
5,4
Nome do Tipo
Descrio
(Tipo utilizado para
informar ...)
Tipo
Base
Tamanho
Observao
100% = 1.0000 ou 1
tsBairro
Bairro do endereo.
60
Bairro.
tsCEP
CEP do endereo.
tsPostalCode
10
tsCodigoAtividade
tsIdCNAE
tsCNPJ
14
tsCFPS
tsCodigoCampanha
tsCodigoVerificacao
16
tsComplementoEndereco
Complemento do endereo.
30
tsCPF
11
tsCST
tsDadosAdicionais
Dados adicionais
256
tsDiscriminacao
1000
tsEmail
E-mail.
500
tsIdentificacaoRequisicao
Identificao da requisio.
10
tsInscricaoMunicipal
Inscrio Municipal.
tsLogradouro
Endereo.
80
tsMunicipio
Nome do municpio.
60
tsMunicipioIBGE
Cdigo do municpio
(Tabela do IBGE).
tsNumeroSerie
Nome do Tipo
tsNumeroEndereco
Descrio
(Tipo utilizado para
informar ...)
Nmero do endereo.
Tipo
Base
Tamanho
tsOutrosDocIdentificacao
Documento de identificao.
14
tsPais
Tipo pas.
tsQuantidade
Tipo quantidade.
tsRazaoSocial
80
tsStatusNFPSe
Status da NFPS-e.
tsStatusRequisicao
Status da Requisio.
tsTelefone
Nmero de telefone.
14
tsTipoSistema
tsUF
Sigla da UF do endereo.
tsValor
Valores.
15, 2
tsVersao
3, 2
tsMotivoCancelamento
120
Observao
Tipo do Elemento
<Tipo do Elemento 1>
<Tipo do Elemento ...>
<Tipo do Elemento a>
<Tipo do Elemento b.>
<Tipo do Elemento c.>
<Tipo do Elemento N>
Ocorrncia
x-y
x-y
Descrio do elemento
<Descrio do elemento 1>
<Descrio do elemento ...>
<Descrio do elemento a>
<Descrio do elemento b>
<Descrio do elemento c>
<Descrio do elemento N>
x-y
x-y
Tipo do Elemento
Ocorrncia
CEP
tsCEP
1-1
CEP.
Descrio
PostalCode
tsPostalCode
1-1
tcInformacaoAEDF
Tipo que representa informaes da AEDF.
Nome do Elemento
AEDF
Tipo do Elemento
tsNumeroAEDF
Ocorrncia
1-1
Descrio
Nmero da AEDF.
TipoAEDF
tsTipoAEDF
1-1
tcMunicipio
Tipo que representa um Municpio brasileiro ou do exterior.
Nome do Elemento
Tipo do Elemento
Ocorrncia
CodigoMunicipio
tsMunicipioIBGE
1-1
NomeMunicipio
tsMunicipio
1-1
(Choice)
Descrio
Cdigo do municpio (Tabela do IBGE).
Apenas para municpios brasileiros.
Nome do municpio.
Apenas para municpios do exterior.
tcEndereco
Tipo que representa um Endereo
Nome do Elemento
Logradouro
NumeroEndereco
ComplementoEndereco
Bairro
Municipio
CodigoPostal
UF
Pais
Tipo do Elemento
tsLogradouro
tsNumeroEndereco
tsComplementoEndereco
tsBairro
tcMunicipio
tcCodigoPostal
tsUF
tsPais
Ocorrncia
1-1
0-1
0-1
1-1
1-1
1-1
0-1
0-1
tcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Descrio
Endereo.
Nmero do endereo.
Complemento do endereo.
Bairro do endereo.
Municpio do endereo.
Cdigo postal do endereo.
Usar quando o endereo for do Brasil
Usar quando o endereo for do Exterior
tcEndereco
Tipo que representa um Endereo
Nome do Elemento
Logradouro
NumeroEndereco
Nome do Elemento
Telefone
Email
Tipo do Elemento
tsLogradouro
tsNumeroEndereco
Tipo do Elemento
tsTelefone
tsEmail
Ocorrncia
1-1
0-1
Ocorrncia
0-1
1-1
Descrio
Endereo.
Nmero do endereo.
Descrio
Nmero de telefone.
Endereo de e-mail.
tcCPFCNPJ
Tipo que representa um CPF/CNPJ
Nome do Elemento
Tipo do Elemento
Ocorrncia
CPF
tsCPF
1-1
Descrio
Nmero no Cadastro de Pessoas Fsicas.
CNPJ
tsCNPJ
1-1
(Choice)
tcDocIdTomador
Tipo que representa um documento de identificao do tomador.
Nome do Elemento
(Choice)
Tipo do Elemento
Ocorrncia
tcCPFCNPJ
1-1
Descrio
CPF ou CNPJ do tomador.
tsOutrosDocIdentificacao
1-1
CPFCNPJ
Outros
tcIdentificacaoTomador
Representa dados de identificao do tomador de servio.
Nome do Elemento
Tipo do Elemento
Ocorrncia
DocIdTomador
tcDocIdTomador
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
Descrio
Nmero de CPF, CNPJ ou de outros documentos
de identificao.
Nmero de inscrio municipal do tomador.
tcDadosTomador
Representa dados do tomador de servio.
Nome do Elemento
Tipo do Elemento
IdentificacaoTomador
RazaoSocial
Endereco
Contato
tcIdentificacaoTomador
tsRazaoSocial
tcEndereco
tcContato
Ocorrncia
1-1
1-1
1-1
1-1
Descrio
Identificador para o tomador.
Razo social do tomador.
Endereo do tomador.
Contato do tomador
tcIdentificacaoPrestador
Representa dados de identificao do prestador de servio.
Nome do Elemento
Tipo do Elemento
CNPJ
tsCNPJ
Ocorrncia
1-1
Descrio
Nmero do CNPJ.
InscricaoMunicipal
tsInscricaoMunicipal
0-1
tcDadosPrestador
Representa dados do prestador de servio.
Nome do Elemento
Tipo do Elemento
IdentificacaoPrestador
RazaoSocial
Endereco
Contato
tcIdentificacaoPrestador
tsRazaoSocial
tcEndereco
tcContato
Ocorrncia
1-1
1-1
1-1
1-1
Descrio
Identificador para o tomador.
Razo social do tomador.
Endereo do tomador.
Contato do tomador
tcItemServico
Tipo que representa um item de servio de uma requisio ou NFPS-e.
Nome do Elemento
Tipo do Elemento
Ocorrncia
IdCNAE
CodigoAtividade
DescricaoServico
CST
Aliquota
ValorUnitario
Quantidade
ValorTotal
tsIdCNAE
tsCodigoAtividade
tsDiscriminacao
tsCST
tsAliquota
tsValor
tsQuantidade
tsValor
1-1
1-1
1-1
1-1
1-1
1-1
1-1
1-1
Descrio
tcDadosServico
Tipo que representa os dados do(s) servio(s) de uma requisio ou NFPS-e.
Nome do Elemento
Tipo do Elemento
Ocorrncia
ItensServico
BaseCalculo
ValorISSQN
BaseCalculoSubstituicao
ValorISSQNSubstituicao
ValorTotalServicos
DadosAdicionais
tcItemServico
tsValor
tsValor
tsValor
tsValor
tsValor
tsDiscriminacao
1-999
1-1
1-1
0-1
0-1
1-1
0-1
Descrio
tcInfRequisicao
Representa dados informativos da requisio.
Id
Nome do Elemento
Tipo do Elemento
tsTagId
Ocorrncia
0-1
Versao
TipoSistema
Identificacao
AEDF
tsVersao
tsTipoSistema
tsIdentificacaoRequisicao
tsInformacaoAEDF
1-1
1-1
0-1
1-1
CodigoVerificacao
DataEmissao
NumeroSerieRequisicao
NumeroSerieSubst
CFPS
StatusRequisicao
DadosServico
Prestador
Tomador
tsCodigoVerificacao
Date
tsNumeroSerie
tsNumeroSerie
tsCFPS
tsStatusRequisicao
tcDadosServico
tcDadosPrestador
tcDadosTomador
0-1
1-1
0-1
0-1
1-1
0-1
1-1
0-1
1-1
Descrio
Identificador da requisio composto pela inscrio municipal,
AEDF e nmero da requisio. Definido pelo Cliente NFPS-e.
Verso do XML Schema deste tipo complexo.
Tipo do sistema (homologao 0 ou produo 1).
Identificador para a requisio.
Informaes de Autorizao para Emisso de Documentos
Fiscais Eletrnicos.
Cdigo de Verificao da NFPS-e. Gerado pelo Cliente NFPS-e.
Data da emisso da NFPS-e.
Nmero de srie desta requisio. Definido pelo Cliente NFPS-e
Nmero de srie da NFPS-e a substituda por esta.
Cdigo fiscal de prestao de servio.
Status da requisio. Definido pelo Cliente NFPS-e.
Dados do(s) servio(s).
Dados do prestador. Definido pelo Cliente NFPS-e.
Dados do tomador.
tcInfRequisicaoCancelamento
Representa dados informativos da requisio.
Nome do Elemento
Versao
TipoSistema
AEDF
Tipo do Elemento
tsVersao
tsTipoSistema
tsInformacaoAEDF
Ocorrncia
1-1
1-1
1-1
CodigoVerificacao
NumeroSerie
tsCodigoVerificacao
tsNumeroSerie
0-1
0-1
MotivoCancelamento
tcMotivoCancelmento
0-1
Descrio
Verso do XML Schema deste tipo complexo.
Tipo do sistema (homologao 0 ou produo 1).
Informaes de Autorizao para Emisso de Documentos
Fiscais Eletrnicos.
Cdigo de Verificao da NFPS-e. Gerado pelo Cliente NFPS-e.
Nmero de srie da requisio que dever ser cancelada.
Definido pelo Cliente NFPS-e
Motivo do Cancelamento da NFPS-e.
tcRequisicao
Representa a estrutura da requisio opcionalmente assinada.
Nome do Elemento
InfRequisicao
Tipo do Elemento
tcInfRequisicao
Ocorrncia
1-1
Signature
dsig:Signature
0-1
Autenticacao
tsAutenticacao
0-1
Descrio
Dados informativos da requisio (ver detalhes na tabela
tcInfRequisicao).
Deve ser utilizado o padro brasileiro de assinaturas digital ADRB, conforme DOC-ICP-15.03.
Ver tsAutenticacao. Deve ser estar presente apenas quando no
for utilizada a tag Signature.
tcInfNFPSe
Representa dados informativos da NFPS-e.
Nome do Elemento
Id
Versao
TipoSistema
Identificacao
AEDF
CodigoVerificacao
NumeroSerie
NumeroSerieSubst
DataEmissao
DataProcessamento
DataCancelamento
MotivoCancelamento
CFPS
CodigoCampanha
StatusNFPSe
DadosServico
Prestador
Tomador
Tipo do Elemento
tsTagId
tsVersao
tsTipoSistema
tsIdentificacaoRequisicao
tsInformacaoAEDF
tsCodigoVerificacao
tsNumeroSerie
tsNumeroSerie
Date
Date
DateTime
tsDiscriminacao
tsCFPS
tsCodigoCampanha
tsStatusNFPSe
tcDadosServico
tcDadosPrestador
tcDadosTomador
Ocorrncia
1-1
1-1
1-1
0-1
1-1
0-1
1-1
0-1
1-1
1-1
0-1
0-1
1-1
0-1
1-1
1-1
1-1
1-1
Descrio
Identificador da NFPS-e.
Verso do XML Schema deste tipo complexo.
Tipo do sistema (homologao 0 ou produo 1).
Identificador para a requisio associada.
Autorizao para emisso de documentos fiscais eletrnicos.
Cdigo de Verificao da NFPS-e.
Nmero de srie da NFPS-e.
Nmero de srie da NFPS-e substituda por esta.
Data da emisso da NFPS-e.
Data do processamento da NFPS-e.
Data de cancelamento da NFPS-e.
Motivo do cancelamento da NFPS-e.
Cdigo fiscal de prestao de servio.
Cdigo promocional de campanha.
Status da NFPS-e.
Dados do(s) servio(s).
Dados do prestador.
Dados do tomador.
tcProtocolo
Representa dados do Protocolo da NFPS-e.
Nome do Elemento
Id
Valor do tcProtocolo
Tipo do Elemento
tsTagId
Base64
Ocorrncia
1-1
1-1
Descrio
Identificador do Protocolo da NFPS-e.
Contm um carimbo do tempo no padro especificado pela RFC
3161 (http://www.ietf.org/rfc/rfc3161.txt) codificado em
Base64.
tcNFPSe
Representa a estrutura da NFPS-e assinada
Nome do Elemento
InfNFPSe
Tipo do Elemento
tcInfNFPSe
Protocolo
tcProtocolo
Ocorrncia
1-1
1-1
Descrio
Dados informativos da NFPSe (ver detalhes na tabela
tcInfNFPSe).
Dados do Protocolo da NFPSe (ver detalhes na tabela
tcProtocolo).
Localidade do Tomador:
0. Do Municpio
1. De Outro Municpio de SC
3. Do Exterior
</Municipio>
<CodigoPostal>
<CEP>88020001</CEP>
</CodigoPostal>
<UF>SC</UF>
</Endereco>
<Contato>
<Email>cacique@carijo.com.br</Email>
<Telefone>4812345678</Telefone>
</Contato>
</Tomador>
</InfRequisicao>
tipo
complexo
tcInfRequisicaoCancelamento.
Todos
os
campos
so
<CodigoMunicipio>4205407</CodigoMunicipio>
</Municipio>
<CodigoPostal>
<CEP>88088000</CEP>
</CodigoPostal>
<UF>SC</UF>
</Endereco>
<Contato>
<Email>pac@pmf.sc.gov.br</Email>
<Telefone>32222222</Telefone>
</Contato>
</Prestador>
<Tomador>
<IdentificacaoTomador>
<DocIdTomador>
<CPFCNPJ>
<CNPJ>83930545000124</CNPJ>
</CPFCNPJ>
</DocIdTomador>
</IdentificacaoTomador>
<RazaoSocial>TRIBO CARIJOS</RazaoSocial>
<Endereco>
<Logradouro>MORRO DOS CAVALOS</Logradouro>
<NumeroEndereco>123</NumeroEndereco>
<Bairro>CENTRO</Bairro>
<Municipio>
<CodigoMunicipio>4211900</CodigoMunicipio>
</Municipio>
<CodigoPostal>
<CEP>88020001</CEP>
</CodigoPostal>
<UF>SC</UF>
</Endereco>
<Contato>
<Email>cacique@carijo.com.br</Email>
<Telefone>4812345678</Telefone>
</Contato>
</Tomador>
</InfNFPSe>
<Protocolo Id="PDDE-070201240050001_9407746">...</Protocolo>
</NFPSe>