NOTA FISCAL DE SERVIÇOS ELETRÔNICA (NFS-e)

[Pages:16]NOTA FISCAL DE SERVI?OS ELETR?NICA (NFS-e)

Manual de Utiliza??o do Web Service

(Modelo Nacional - Vers?o 1.0)

P?gina 2 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

?ndice

?NDICE .......................................................................................................................................................................2 1. INTRODU??O ....................................................................................................................................................3 2. SERVI?OS DISPON?VEIS ..................................................................................................................................4

2.1. SERVI?OS DO MODELO NACIONAL ................................................................................................................... 4 2.1.1. Recep??o e Processamento de Lote de RPS (ass?ncrono) .................................................................. 4 2.1.2. Consulta de Situa??o de Lote de RPS..................................................................................................4 2.1.3. Consulta de Lote de RPS......................................................................................................................4 2.1.4. Consulta de NFS-e................................................................................................................................ 4 2.1.5. Cancelamento de NFS-e.......................................................................................................................4

2.2. SERVI?OS EXCLUSIVOS DA PCRJ .................................................................................................................... 5 2.2.1. Gera??o de NFS-e (individual, online e s?ncrono) ................................................................................5

3. ESPECIFICA??ES T?CNICAS .........................................................................................................................6 3.1. MODELO NACIONAL ........................................................................................................................................6 3.2. ENDERE?O DO WEBSERVICE ..........................................................................................................................6 3.3. INTERFACES DO WEBSERVICE (WSDL) ...........................................................................................................6 3.4. TAMANHO M?XIMO DAS MENSAGENS XML ....................................................................................................... 6 3.5. SCHEMAS XML .............................................................................................................................................. 6 3.6. EXEMPLOS ..................................................................................................................................................... 7 3.7. EXEMPLO DE ASSINATURA DIGITAL DA MENSAGEM XML.....................................................................................7 3.8. EXEMPLO DE ASSINATURA DIGITAL DE ELEMENTOS XML....................................................................................8

4. C?DIGOS DE CANCELAMENTO, ERROS E ALERTAS ................................................................................11 4.1. C?DIGOS DE CANCELAMENTO DE NFS-E (MUNIC?PIO DO RIO DE JANEIRO).......................................................11 4.2. RELA??O DE ERROS (MUNIC?PIO DO RIO DE JANEIRO) .................................................................................... 11 4.3. RELA??O DE ALERTAS (MUNIC?PIO DO RIO DE JANEIRO) .................................................................................14

5. INDICA??O DO C?DIGO DE BENEF?CIO FISCAL........................................................................................15 6. CRIANDO UM LINK PARA A NFS-E EMITIDA................................................................................................16

Revisado em 10/05/2021

P?gina 3 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

1. Introdu??o

Este manual tem como objetivo apresentar a defini??o das especifica??es e crit?rios t?cnicos necess?rios para utiliza??o do Web Service do Sistema de Nota Fiscal de Servi?os Eletr?nica (NFS-e) disponibilizado pela Prefeitura para as empresas prestadoras e/ou tomadoras de servi?os. Atrav?s do Web Service disponibilizado, as empresas podem integrar seus pr?prios sistemas de informa??es com o Sistema de NFS-e da Prefeitura. Desta forma, consegue-se automatizar o processo de emiss?o, consulta e cancelamento de NFS-e. O Web Service e todos os seus servi?os, referenciados nesse documento, s?o baseados no modelo nacional de NFS-e, definido pela Associa??o Brasileira de Secret?rios e Dirigentes das Finan?as dos Munic?pios das Capitais (ABRASF) e pela Receita Federal do Brasil (RFB).

Revisado em 10/05/2021

P?gina 4 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

2. Servi?os Dispon?veis 2.1. Servi?os do Modelo Nacional

A seguir est?o resumidos os servi?os disponibilizados pelo WebService visando automatizar o processo de emiss?o, consulta e cancelamento de Notas Fiscais de Servi?os Eletr?nicas (NFS-e).

ATEN??O!

A descri??o completa destes m?todos pode ser obtida diretamente do Manual de Integra??o da ABRASF:

Todos os servi?os a seguir exigem o uso de certificados digitais ICP-Brasil para autentica??o.

2.1.1. Recep??o e Processamento de Lote de RPS (ass?ncrono)

Esse servi?o compreende a recep??o do Lote de RPS, a resposta com o n?mero do protocolo gerado para esta transa??o e o processamento do lote (ass?ncronamente)

2.1.2. Consulta de Situa??o de Lote de RPS

Esse servi?o efetua a consulta da situa??o de um Lote de RPS j? enviado.

2.1.3. Consulta de Lote de RPS

Esse servi?o permite ao contribuinte obter as NFS-e que foram geradas a partir do Lote de RPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista de erros e/ou inconsist?ncias encontradas no Lode de RPS enviado. Na valida??o do lote, s?o retornados todos os erros verificados. Excepcionalmente, havendo uma excessiva quantidade de erros, poder? ser definido um limitador para a quantidade de erros retornados.

2.1.4. Consulta de NFS-e

Esse servi?o permite a obten??o de determinada NFS-e j? gerada.

2.1.5. Cancelamento de NFS-e

Esse servi?o permite o cancelamento direto de uma NFS-e sem substitui??o da mesma por outra. Veja no item 4.1 os c?digos de cancelamento dispon?veis.

Revisado em 10/05/2021

P?gina 5 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

2.2.

Servi?os exclusivos da PCRJ 2.2.1. Gera??o de NFS-e (individual, online e s?ncrono)

Esse servi?o compreende o envio (s?ncrono) de um ?nico RPS e o retorno da respectiva NFS-e gerada e/ou mensagens de erros e alerta no processamento do RPS.

Esse servi?o ser? executado atrav?s da chamada ao m?todo GerarNfse, passando a mensagem XML

como par?metro com a estrutura definida na tabela que segue.

# Nome 1 GerarNfseEnvio

Rps

Tipo tcRps

GerarNfseEnvio

Pai

1

Ocorr?ncia 1-1 1-1

Observa??o

Em resposta a chamada do servi?o ser? devolvida a estrutura definida na tabela a seguir.

# Nome 1 GerarNfseResposta

CompNfse ListaMensagemRetorno 2 ListaMensagemRetorno

GerarNfseResposta

Tipo

Pai

CompNfse ListaMensagemRetorno

1

ListaMensagemRetorno

1

Ocorr?ncia 1-1 1-1 0-1 1-1

Observa??o Choice

OBS: O elemento CompNfse ? retornado caso o RPS seja processado com sucesso. Em caso de alertas, o RPS ? processado, sendo retornado a(s) mensagen(s) de alerta (tipo ListaMensagemRetorno) e a NFSe gerada (tipo CompNfse). Em caso de erro, a NFS-e n?o ? gerada, sendo retornado apenas a(s) mensagen(s) de erro(s) ocorridos (tipo ListaMensagemRetorno).

Revisado em 10/05/2021

P?gina 6 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

3. Especifica??es T?cnicas

3.1. Modelo Nacional

O Modelo Nacional de NFS-e, elaborado pela ABRASF em conjunto com a Receita Federal, descreve a arquitetura de comunica??o com o contribuinte e a estrutura de dados utilizada pelo WebService, detalhando: os conceitos, premissas e regras de neg?cios envolvidas; as funcionalidades e os servi?os disponibilizados; os padr?es t?cnicos de comunica??o, certifica??o e assinatura digital; a estrutura, esquema e valida??o das mensagens XML; o modelo conceitual e operacional de uso dos WebServices; os formatos e padr?es adotados e; os tipos simples e complexos utilizados. Os documentos descritivos do modelo nacional - Modelo de Integra??o - podem ser obtidos atrav?s do endere?o eletr?nico:

3.2. Endere?os dos WebServices

O endere?o eletr?nico de PRODU??O do WebService disponibilizado pela Prefeitura ?: (? necess?rio Certificado Digital para conseguir o acesso) O endere?o para testes/HOMOLOGA??O ?: (? necess?rio Certificado Digital para conseguir o acesso)

ATEN??O: Para acessar estes endere?os e utilizar os WebServices, ? necess?rio se autenticar usando certificado digital ICP-Brasil, conforme explicado no Manual Nacional do Modelo de Integra??o. As assinaturas digitais do RPS, do Lote de RPS e/ou do Cancelamento da NFS-e s?o OPCIONAIS, ficando a crit?rio do contribuinte sua assinatura (ou n?o).

3.3. Interfaces do WebService (WSDL)

As especifica??es de interface do WebService (WSDL) podem ser obtidas, mediante o uso de certificados digitais ICP-Brasil, atrav?s do endere?o eletr?nico:

3.4. Tamanho M?ximo das Mensagens XML

O tamanho m?ximo permitido para o envio de mensagem XML pelo webservice ? de 512 KB

3.5. Schemas XML

Todos os schemas XML utilizados pelo WebService podem ser obtidos no endere?o eletr?nico:

Revisado em 10/05/2021

P?gina 7 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)



3.6. Exemplos

Diversos exemplos de mensagens XML (pedido e retorno) de cada um dos m?todos disponibilizados podem ser obtidos no endere?o eletr?nico:

3.7. Exemplo de assinatura digital da mensagem XML

As mensagens enviadas ao Sistema de Nota Fiscal de Servi?o Eletr?nica da Prefeitura deste Munic?pio s?o documentos eletr?nicos elaborados no padr?o XML e podem (opcionalmente) ser assinados digitalmente utilizando certificado digital.

Veja abaixo um exemplo de assinatura digital da mensagem XML: ''' ''' Exemplo de como assinar uma mensagem XML com um certificado digital. ''' Linguagem: ''' Framework: 3.5 ''' ''' String contendo a pr?pria mensagem XML ''' O certificado que ser? usado para assinar ''' a mensagam XML ''' Um objeto do tipo XmlDocument j? assinado ''' Private Function Assinar(ByVal mensagemXML As String, _

ByVal certificado As _

System.Security.Cryptography.X509Certificates.X509Certificate2) _ As XmlDocument

Dim xmlDoc As New System.Xml.XmlDocument() Dim Key As New System.Security.Cryptography.RSACryptoServiceProvider() Dim SignedDocument As System.Security.Cryptography.Xml.SignedXml Dim keyInfo As New System.Security.Cryptography.Xml.KeyInfo()

xmlDoc.LoadXml(mensagemXML) 'Retira chave privada ligada ao certificado Key = CType(certificado.PrivateKey, _

System.Security.Cryptography.RSACryptoServiceProvider) 'Adiciona Certificado ao Key Info keyInfo.AddClause(New _

System.Security.Cryptography.Xml.KeyInfoX509Data(certificado)) SignedDocument = New System.Security.Cryptography.Xml.SignedXml(xmlDoc) 'Seta chaves SignedDocument.SigningKey = Key

Revisado em 10/05/2021

P?gina 8 de 16

NOTA FISCAL DE SERVI?O ELETR?NICA (NFS-e)

SignedDocument.KeyInfo = keyInfo ' Cria referencia Dim reference As New System.Security.Cryptography.Xml.Reference() reference.Uri = String.Empty ' Adiciona transformacao a referencia reference.AddTransform(New _

System.Security.Cryptography.Xml.XmlDsigEnvelopedSignatureTransform()) reference.AddTransform(New _

System.Security.Cryptography.Xml.XmlDsigC14NTransform(False)) ' Adiciona referencia ao xml SignedDocument.AddReference(reference) ' Calcula Assinatura puteSignature() ' Pega representa??o da assinatura Dim xmlDigitalSignature As System.Xml.XmlElement = SignedDocument.GetXml() ' Adiciona ao doc XML xmlDoc.DocumentElement.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, True)) Return xmlDoc End Function

3.8. Exemplo de assinatura digital de elementos XML

Alguns dos elementos no documento xml podem (opcionalmente) ser assinados individualmente. Veja abaixo um exemplo de como assinar digitalmente esses elementos: Imports System.Xml Imports System.Security.Cryptography Imports System.Security.Cryptography.Xml Imports System.Security.Cryptography.X509Certificates

...

''' ''' Exemplo de como assinar elementos de um documento XML com um certificado digital. ''' Linguagem: ''' Framework: 3.5 ''' ''' ''' O documento que contem os elementos que devem ser assinados ''' ''' O elemento que contem as tags a serem assinadas ''' Ex.:

Revisado em 10/05/2021

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download