SISTEMA DE NF-e .gov.br

[Pages:65]SISTEMA DE NF-e

Manual de Utiliza??o do Web Service

Vers?o: 2.1 Data de Libera??o: 20-03-2007 Para baixar a vers?o mais atualizada deste documento, acesse o link:

20/3/2007

P?gina 1 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

?ndice

1 INTRODU??O .....................................................................................................................................................4

2 INTERFACES DISPON?VEIS...............................................................................................................................5

2.1 ENVIO DE RPS ...............................................................................................................................................5 2.2 ENVIO DE LOTE DE RPS..................................................................................................................................5 2.3 TESTE DE ENVIO DE LOTE DE RPS ..................................................................................................................5 2.4 CONSULTA DE NF-E ........................................................................................................................................5 2.5 CONSULTA DE NF-E RECEBIDAS ......................................................................................................................5 2.6 CONSULTA DE NF-E EMITIDAS .........................................................................................................................5 2.7 CONSULTA DE LOTE ........................................................................................................................................6 2.8 CONSULTA INFORMA??ES DO LOTE .................................................................................................................6 2.9 CANCELAMENTO DE NF-E................................................................................................................................6 2.10 CONSULTA DE CNPJ.......................................................................................................................................6

3 ARQUITETURA DE COMUNICA??O.................................................................................................................7

3.1 MODELO CONCEITUAL.....................................................................................................................................7 3.2 PADR?ES T?CNICOS .......................................................................................................................................8

3.2.1 Padr?o de Comunica??o ......................................................................................................................8 3.2.2 Padr?o de Certificado Digital ................................................................................................................8 3.2.3 Padr?o de Assinatura Digital ................................................................................................................9 3.2.4 Valida??o de Assinatura Digital pelo Sistema de NF-e ......................................................................11 3.2.5 Resumo dos Padr?es T?cnicos..........................................................................................................12 3.3 MODELO OPERACIONAL .................................................................................................................................13 3.3.1 Servi?os ..............................................................................................................................................13 3.4 PADR?O DAS MENSAGENS XML .....................................................................................................................14 3.4.1 Valida??o da estrutura das Mensagens XML.....................................................................................14 3.4.2 Schemas XML (arquivos XSD) ...........................................................................................................15 3.4.3 Vers?o dos Schemas XML .................................................................................................................15 3.4.4 Regras de preenchimento dos campos ..............................................................................................18 3.4.5 Tratamento de caracteres especiais no texto de XML .......................................................................19

4 WEB SERVICE LOTENFE.................................................................................................................................20

4.1 WSDL..........................................................................................................................................................21 4.2 TIPOS UTILIZADOS .........................................................................................................................................22

4.2.1 Tipos Simples .....................................................................................................................................22 4.2.2 Tipos Complexos ................................................................................................................................26

20/3/2007

P?gina 2 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

4.3 SERVI?OS E M?TODOS..................................................................................................................................31 4.3.1 Regras Gerais.....................................................................................................................................31 4.3.2 Envio de RPS......................................................................................................................................33 4.3.3 Envio de Lote de RPS (EnvioLoteRPS) .............................................................................................37 4.3.4 Teste de Envio de Lote de RPS (TesteEnvioLoteRPS) .....................................................................40 4.3.5 Pedido de Consulta de NF-e (ConsultaNFe)......................................................................................41 4.3.6 Pedido de Consulta de NF-e Recebidas (ConsultaNFeRecebidas)...................................................43 4.3.7 Pedido de Consulta de NF-e Emitidas (ConsultaNFeEmitidas) .........................................................47 4.3.8 Pedido de Consulta de Lote (ConsultaLote).......................................................................................49 4.3.9 Pedido de Informa??es do Lote (ConsultaInformacoesLote) .............................................................51 4.3.10 Pedido de Cancelamento de NF-e (CancelamentoNFe)....................................................................53 4.3.11 Pedido de Consulta de CNPJ (ConsultaCNPJ)..................................................................................57

4.4 TABELA DE ERROS E ALERTAS.......................................................................................................................59 4.4.1 Erros ...................................................................................................................................................59 4.4.2 Alertas.................................................................................................................................................62

5 ARQUIVOS DE EXEMPLOS..............................................................................................................................64

ANEXO I .....................................................................................................................................................................65

TABELA DE MUNIC?PIOS .............................................................................................................................................65

20/3/2007

P?gina 3 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

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 disponibilizado pela Prefeitura de S?o Paulo para as empresas prestadoras e/ou tomadoras de servi?os.

Atrav?s do Web Service as empresas poder?o integrar seus pr?prios sistemas de informa??es com o Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo. Desta forma, consegue-se automatizar o processo de emiss?o, consulta e cancelamento de NF-e.

20/3/2007

P?gina 4 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

2 INTERFACES DISPON?VEIS

Atrav?s do Web Service, o Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo, disponibiliza uma s?rie de interfaces que poder?o ser acessadas pelos sistemas dos contribuintes. A seguir, est?o resumidas as interfaces dispon?veis e suas respectivas funcionalidades b?sicas.

2.1 ENVIO DE RPS Atrav?s desta interface, os prestadores de servi?os poder?o enviar um RPS emitido por seu sistema para que seja substitu?do por uma Nota Fiscal Eletr?nica. Esta interface destinasse aos prestadores que desejam emitir NF-e online e individualmente. Para emiss?es de grandes volumes recomendamos a utiliza??o da interface Envio de Lote de RPS.

2.2 ENVIO DE LOTE DE RPS Atrav?s desta interface, os prestadores de servi?os poder?o enviar lotes de RPS emitidos por seus sistemas para que sejam substitu?dos por Notas Fiscais Eletr?nicas. Esta interface destina-se aos prestadores que desejam emitir NF-e ofline e em grandes volumes.

2.3 TESTE DE ENVIO DE LOTE DE RPS O uso desta interface ? opcional. A interface de Envio de Lote de RPS faz exatamente as mesmas verifica??es, entretanto na interface de Teste, nenhuma NF-e ? gerada. Esta interface dever? ser usada apenas na fase de adapta??o dos sistemas dos contribuintes. Nos casos de sistemas j? adaptados, seu uso resulta em duplicidade de esfor?os desnecess?rios.

2.4 CONSULTA DE NF-E Esta interface permite os prestadores de servi?os consultarem as NF-e emitidas por ele.

2.5 CONSULTA DE NF-E RECEBIDAS Esta interface possibilita aos tomadores e/ou prestadores de servi?os consultarem as NF-e que tiverem sido emitidas para ele, possibilitando, por exemplo, a alimenta??o autom?tica de seu m?dulo de contas a pagar.

2.6 CONSULTA DE NF-E EMITIDAS Esta interface possibilita aos prestadores de servi?os consultarem as NF-e que tiverem sido emitidas por ele.

20/3/2007

P?gina 5 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

2.7 CONSULTA DE LOTE Ap?s o envio bem sucedido de um Lote de RPS, o Web Service retorna diversas informa??es, entre elas o n?mero do lote processado. Com esta interface, basta informar o n?mero do lote desejado para receber as informa??es de todas as NF-e geradas neste lote.

2.8 CONSULTA INFORMA??ES DO LOTE Ap?s o envio bem sucedido de um Lote de RPS, o Web Service retorna diversas informa??es, entre elas o n?mero do lote processado. Com esta interface, basta informar o n?mero do lote desejado para receber informa??es resumidas: data/hora de envio do lote, quantidade de notas processadas, tempo de processamento, etc... Para ter informa??es das notas processadas, deve-se usar a interface de Consulta de Lote.

2.9 CANCELAMENTO DE NF-E Com esta interface, os prestadores de servi?os poder?o cancelar as NF-e emitidas por ele, informando apenas os n?meros da NF-e que dever?o ser cancelados.

2.10 CONSULTA DE CNPJ Esta interface possibilita aos tomadores e/ou prestadores de servi?os consultarem quais Inscri??es Municipais (CCM) est?o vinculadas a um determinado CNPJ e se estes Contribuintes j? emitem NF-e.

20/3/2007

P?gina 6 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

3 ARQUITETURA DE COMUNICA??O

3.1 MODELO CONCEITUAL O Web Service do Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo ir? disponibilizar as seguintes funcionalidades:

A. Envio de RPS; B. Envio de Lote de RPS; C. Teste de Envio de Lote de RPS; D. Consulta de NF-e; E. Consulta de NF-e Recebidas; F. Consulta de NF-e Emitidas; G. Consulta de Lote; H. Consulta de Informa??es de Lote; I. Cancelamento de NF-e; J. Consulta de CNPJ.

Existir? um ?nico Web Service com todos os servi?os apresentados a cima. O fluxo de comunica??o ? sempre iniciado pelo sistema do contribuinte atrav?s do envio de uma mensagem XML ao Web Service com o pedido do servi?o desejado.

O pedido de servi?o ser? atendido na mesma conex?o (todos os servi?os ser?o s?ncronos). O processamento do pedido do servi?o ? conclu?do na mesma conex?o, com a devolu??o de uma mensagem XML contendo o retorno do processamento do servi?o pedido;

O diagrama a seguir ilustra o fluxo conceitual de comunica??o entre o sistema do contribuinte e o Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo:

20/3/2007

P?gina 7 de 65

Prefeitura da Cidade de S?o Paulo

Notas Fiscais Eletr?nicas (NF-e) Manual de Utiliza??o do Web Service

3.2 PADR?ES T?CNICOS

3.2.1 Padr?o de Comunica??o A comunica??o entre os sistemas de informa??es dos contribuintes e o Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo ser? baseada em um Web Service disponibilizado no Sistema de Notas Fiscais Eletr?nicas?. O meio f?sico de comunica??o utilizado 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 atrav?s de certificados digitais, eliminando a necessidade de identifica??o do usu?rio atrav?s 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 Eletr?nicas? da Prefeitura de S?o Paulo 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.

3.2.2 Padr?o de Certificado Digital Os certificados digitais utilizados no Sistema de Notas Fiscais Eletr?nicas? da Prefeitura de S?o Paulo ser?o emitidos por Autoridade Certificadora credenciada pela Infra-estrutura de Chaves P?blicas Brasileira ? ICP-Brasil, tipo A1, A3 ou A4, devendo conter o CNPJ do propriet?rio do certificado digital.

20/3/2007

P?gina 8 de 65

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

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

Google Online Preview   Download