NOTA FISCAL DE SERVIÇOS ELETRÔNICA (NFS-e) - Governo do Estado de ...

NOTA FISCAL DE SERVI?OS

ELETR?NICA (NFS-e)

Manual de Utiliza??o do Web Service

( Modelo Nacional ¨C Vers?o 2.03 )

Sistema desenvolvido por Tiplan Tecnologia em Sistema de Informa??o. Todos os direitos reservados.



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.

3.

4.

5.

SERVI?OS DO MODELO NACIONAL ..................................................................................................................... 4

2.1.1.

Enviar Lote de RPS S¨ªncrono ................................................................................................................ 4

2.1.2.

Recep??o e Processamento de Lote de RPS (s¨ªncrono)...................................................................... 4

2.1.3.

Consulta de Lote de RPS ...................................................................................................................... 4

2.1.4.

Consulta de NFS-e por RPS ................................................................................................................. 4

2.1.5.

Consulta de NFS-e por Faixa ................................................................................................................ 4

2.1.6.

Consulta de NFS-e ¨C Servi?os Tomados ou Intermediados ................................................................. 5

2.1.7.

Consulta de NFS-e ¨C Servi?os Prestados ............................................................................................. 5

2.1.8.

Gera??o de NFS-e................................................................................................................................. 6

2.1.9.

Cancelamento de NFS-e ....................................................................................................................... 6

2.1.10.

Substitui??o de NFS-e ........................................................................................................................... 6

ESPECIFICA??ES T?CNICAS ........................................................................................................................... 7

3.1.

MODELO NACIONAL .......................................................................................................................................... 7

3.2.

ENDERE?O DO W EBSERVICE ¨C HOMOLOGA??O ................................................................................................. 7

3.3.

ENDERE?O DO W EBSERVICE ............................................................................................................................ 7

3.4.

INTERFACES DO W EBSERVICE (WSDL) ............................................................................................................. 7

3.5.

TAMANHO M?XIMO DAS MENSAGENS XML......................................................................................................... 7

3.6.

SCHEMAS XML................................................................................................................................................. 8

3.7.

EXEMPLOS ....................................................................................................................................................... 8

3.8.

EXEMPLO DE ASSINATURA DIGITAL DA MENSAGEM XML ...................................................................................... 8

3.9.

EXEMPLO DE ASSINATURA DIGITAL DE ELEMENTOS XML ..................................................................................... 9

C?DIGOS DE CANCELAMENTO, ERROS E ALERTAS .................................................................................12

4.1.

C?DIGOS DE CANCELAMENTO DE NFS-E (EXCLUSIVO DESTE MUNIC?PIO) ..........................................................12

4.2.

RELA??O DE ERROS (EXCLUSIVO DESTE MUNIC?PIO) ........................................................................................12

4.3.

RELA??O DE ALERTAS (EXCLUSIVO DESTE MUNIC?PIO) .....................................................................................15

CRIANDO UM LINK PARA A NFS-E EMITIDA .................................................................................................16

Revisado em 30/08/2022

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 30/08/2022

P¨¢gina 4 de 16

NOTA FISCAL DE SERVI?O

ELETR?NICA (NFS-e)

2.

2.1.

Servi?os Dispon¨ªveis

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). Todos os servi?os exigem o

uso de certificados digitais ICP-Brasil para autentica??o.

ATEN??O!

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



2.1.1. Enviar Lote de RPS S¨ªncrono

Esse servi?o compreende a recep??o do Lote de RPS. Quando efetuada a recep??o, o Lote ser¨¢

processado e ser?o feitas as valida??es necess¨¢rias e gera??o das NFS-e.

2.1.2. Recep??o e Processamento de Lote de RPS (s¨ª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. Quando efetuada a recep??o, o Lote entrar¨¢ na fila para

processamento posterior quando ser?o feitas as valida??es necess¨¢rias e gera??o das NFS-e.

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 Lote 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 por RPS

Esse servi?o efetua a consulta de uma NFS-e a partir do n¨²mero de RPS que a gerou.

2.1.5. Consulta de NFS-e por Faixa

Esse servi?o permite a obten??o de determinadas NFS-e j¨¢ geradas, informando a faixa na qual se

encontram.

Revisado em 30/08/2022

P¨¢gina 5 de 16

NOTA FISCAL DE SERVI?O

ELETR?NICA (NFS-e)

2.1.6. Consulta de NFS-e ¨C Servi?os Tomados ou Intermediados

Esse servi?o permite a obten??o de determinadas NFS-e j¨¢ geradas, informando os dados do

consulente, tomador/intermedi¨¢rio de servi?os e os dados da NFS-e conforme estrutura definida na

tabela que segue.

ConsultarNfseServicoTomadoEnvio

#

Nome

1

ConsultarNfseEnvio

2

3

4

Tipo

Pai

Ocorr¨ºncia

Observa??o

1-1

Consulente

tcIdentificacaoConsulente

1

1-1

NumeroNfse

tsNumeroNfse

1

0-1

1

0-1

1-1

1-1

PeriodoEmissao

DataInicial

date

2

DataFinal

date

2

PeriodoCompetencia

Choice

1

DataInicial

date

3

DataFinal

date

3

0-1

1-1

1-1

Prestador

tcIdentificacaoPrestador

1

0-1

Tomador

tcIdentificacaoTomador

1

0-1

Intermediario

tcIdentificacaoIntermediario

1

0-1

Pagina

tsPagina

1

1-1

2.1.7. Consulta de NFS-e ¨C Servi?os Prestados

Esse servi?o permite a obten??o de determinada NFS-e j¨¢ gerada, informando os dados do prestador de

servi?o e os dados da NFS-e conforme estrutura definida na tabela que segue.

ConsultarNfseServicoPrestadoEnvio

#

Nome

1

ConsultarNfseEnvio

2

3

4

Tipo

Pai

Ocorr¨ºncia

1-1

Prestador

tcIdentificacaoPrestador

1

1-1

NumeroNfse

tsNumeroNfse

1

0-1

1

0-1

1-1

1-1

PeriodoEmissao

DataInicial

date

2

DataFinal

date

2

PeriodoCompetencia

1

Choice

DataInicial

date

3

DataFinal

date

3

0-1

1-1

1-1

Tomador

tcIdentificacaoTomador

1

0-1

Intermediario

tcIdentificacaoIntermediario

1

0-1

Pagina

tsPagina

1

1-1

Revisado em 30/08/2022

Observa??o

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

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

Google Online Preview   Download