WEBSERVICE NFSe. Versão Schema XML 2.01

Transcrição

1 WEBSERVICE NFSe Versão Schema XML 2.01

2 Introdução Este manual tem como objetivo apresentar as especificações e critérios técnicos necessários para utilização do WebService disponibilizado pelas Administrações Tributárias Municipais para as empresas prestadoras e/ou tomadoras de serviços. Utilizando o WebService as empresas poderão integrar seus próprios sistemas de informações com o Sistema de Notas Fiscais de Serviço Eletrônicas das Administrações Tributárias Municipais. Desta forma, consegue-se automatizar o processo de geração, consulta e cancelamento de NFS-e. Nota Fiscal de Serviços Eletrônica (NFse) Nota Fiscal de Serviços Eletrônica (NFS-e) é o documento emitido e armazenado eletronicamente em sistema próprio da Prefeitura, com o objetivo de registrar as operações relativas à prestação de serviços. Interfaces disponíveis Geração da NFSe: Esse serviço compreende a recepção do RPS. Quando efetuada a recepção serão feitas as validações necessárias do RPS e geração das NFS-e. <GerarNfseEnvio xmlns=" <Rps xmlns=" <InfDeclaracaoPrestacaoServico Id="rps1UNICA"> +<Rps> <Competencia> </Competencia> +<Servico> +<Prestador> +<Tomador> <OptanteSimplesNacional>2</OptanteSimplesNacional> <IncentivoFiscal>2</IncentivoFiscal> </InfDeclaracaoPrestacaoServico> </Rps> </GerarNfseEnvio> Listagem 1 Solicitação com RPS para geração da NFSe. As Tags Rps, Servico, Prestador e Tomador foram reduzidas apenas para visualização do Xml completo.

3 Cancelamento de NFse: Esse serviço permite o cancelamento direto de uma NFS-e sem a sua substituição por outra. <CancelarNfseEnvio xmlns=" <Pedido xmlns=" <InfPedidoCancelamento Id="pedidoCancelamento_ / "> <IdentificacaoNfse> <Numero>1</Numero> <CpfCnpj> <Cnpj> </Cnpj> </CpfCnpj> <InscricaoMunicipal>11111</InscricaoMunicipal> <CodigoMunicipio> </CodigoMunicipio> </IdentificacaoNfse> <CodigoCancelamento>2</CodigoCancelamento> </InfPedidoCancelamento> </Pedido> </CancelarNfseEnvio> Listagem 2 Cancelamento de NFSe por número. Consulta de NFse por RPS: Esse serviço efetua a consulta de uma NFS-e a partir do número de RPS que a gerou. <ConsultarNfseRpsEnvio xmlns=" <IdentificacaoRps> <Numero>1</Numero> <Serie>UNICA</Serie> <Tipo>1</Tipo> </IdentificacaoRps> <Prestador> <CpfCnpj> <Cnpj> </Cnpj> </CpfCnpj> <InscricaoMunicipal>11111</InscricaoMunicipal> </Prestador> </ConsultarNfseRpsEnvio> Listagem 3 Consulta de NFSe por número de RPS.

4 Consulta de NFse por Faixa: Esse serviço permite a obtenção de determinada NFS-e já gerada através de um intervalo numérico ou por período de data. <ConsultarNfseFaixaEnvio xmlns=" <Prestador> <CpfCnpj> <Cnpj> </Cnpj> </CpfCnpj> <InscricaoMunicipal>11111</InscricaoMunicipal> </Prestador> <Faixa> <NumeroNfseInicial>1</NumeroNfseInicial> <NumeroNfseFinal>2</NumeroNfseFinal> </Faixa> <Pagina>1</Pagina> </ConsultarNfseFaixaEnvio> Listagem 4 Consulta NFSe por Faixa. Padrão de Comunicação O modelo de comunicação segue o padrão de WebServices definido pelo WS-I Basic Profile. A troca de mensagens entre o WebService 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. As chamadas aos serviços serão feitas enviando como parâmetro um documento XML a ser processado pelo sistema. Padrão das Mensagens XML A especificação adotada para as mensagens XML é a recomendação W3C para XML 1.0, disponível em e a codificação dos caracteres será em UTF-8. As chamadas dos WebServices disponibilizados Administrações Tributárias Municipais e os respectivos resultados do processamento são realizadas com utilização de mensagens com o seguinte padrão: Área de Cabeçalho estrutura XML padrão para todas as mensagens de chamada e retorno de resultado dos WebServices 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

5 Área de Dados estrutura XML variável definida na documentação do Web Service acessado. No Webservice os valores que correspondem o cabeçalho e dados são representados pela classe Input, nela temos os seguintes valores: Input = class(tsoapheader) nfsecabecmsg: string; {Cabeçalho} nfsedadosmsg: string; {Dados} Listagem 5 Classe padrão. Para que a comunicação seja realizada com sucesso primeiro é necessário informar corretamente os parâmetros descritos acima e vale ressaltar que os dados são representados pelo Xml padronizado conforme manual da Abrasf, pois caso não esteja a validação com os schemas irá bloquear a leitura dos dados logo no início da verificação. Dito isto, temos alguns parâmetros que são utilizados internamente pela administração tributária municipal, são elas: Username Nome de usuário devidamente registrada na administração pública. Password Senha também registrada; Prefeitura Nome do município que irá utilizar o serviço. Segue abaixo padrão definido no WSDL de cada interface disponível: GerarNfseEnvio = class(input) private FUsername, FPassword, FPrefeitura: String; public published property Username: String read FUsername write FUsername; property Password: String read FPassword write FPassword; property Prefeitura: String read FPrefeitura write FPrefeitura; Listagem 6 GerarNfseEnvio. CancelarNfseEnvio = class(input) private FUsername, FPassword, FPrefeitura: String; public published property Username: String read FUsername write FUsername; property Password: String read FPassword write FPassword; property Prefeitura: String read FPrefeitura write FPrefeitura;

6 Listagem 7 CancelarNfseEnvio. ConsultarNfseRpsEnvio = class(input) private FUsername, FPassword, FPrefeitura: String; public published property Username: String read FUsername write FUsername; property Password: String read FPassword write FPassword; property Prefeitura: String read FPrefeitura write FPrefeitura; Listagem 8 ConsultarNfseEnvio. ConsultarNfseFaixaEnvio = class(input) private FUsername, FPassword, FPrefeitura, FTipoConsulta: String; public published property Username: String read FUsername write FUsername; property Password: String read FPassword write FPassword; property Prefeitura: String read FPrefeitura write FPrefeitura; property TipoConsulta: String read FTipoConsulta write FTipoConsulta; Listagem 9 ConsultarNfseFaixaEnvio. No caso da consulta por faixa é possível realizar por data ou número da nota. Para isso deve informar o tipo da consulta no momento da solicitação utilizando o parâmetro: TipoConsulta Informe a String D para data e N para numérica. XML de Retorno Após cada solicitação o WebService irá retornar um XML contendo o resultado da solicitação, caso o processamento ocorra normalmente terá as informações desejadas, porém caso ocorra algum erro será exibido o XML com o código do erro, a mensagem de erro e a possível correção, conforme o seguinte padrão: <ns3:gerarnfseresponse xmlns:ns2=" xmlns:ns3=" xmlns:ns4=" <ns2:gerarnfseresposta>

7 <ns2:listamensagemretorno> <ns2:mensagemretorno> <ns2:codigo>e160</ns2:codigo> <ns2:mensagem>arquivo em desacordo com o XML Schema</ns2:Mensagem> <ns2:correcao>consulte o Manual da NFS-e para saber quais são as versões de XML Schema suportadas pelo sistema</ns2:correcao> </ns2:mensagemretorno> </ns2:listamensagemretorno> </ns2:gerarnfseresposta> </ns3:gerarnfseresponse> Listagem 10 Retorno com erros. Exemplo de solicitação realizada em Delphi(Pascal) Var Request: ConsultarNfseRpsEnvio; Response: ConsultarNfseRpsResposta; pnfse: INFSe; {WSDL} begin Try pnfse:= GetINFSe(True, 'Path do WSLD',HTTPRIO); Response := ConsultarNfseRpsResposta.Create; Request := ConsultarNfseRpsEnvio.Create; Request.nfseCabecMsg := 'CABECALHO'; Request.nfseDadosMsg := 'XML'; Request.Username := 'USUARIO'; Request.Password := 'SENHA'; Request.Prefeitura := 'PREFEITURA'; Response.outputXML := (HTTPRIO as INFSe).ConsultarNfsePorRps(Request).outputXML; if Response.outputXML <> EmptyStr Then Showmessage(Response.outputXML); Finally FreeAndNil(Request); FreeAndNil(Response); FreeAndNil(Nfse); End; Listagem 11 Exemplo feito em Delphi (Pascal).

8 Referências Manual de Integração Abrasf Versão 2.01 Dezembro