Manual para Envio de Arquivo de Cupons Fiscais via WebService

GEINF - CRE - SEFIN RO

VERSO 1.0 14/01/2012

ndice
1. 2. 3. 4. 5. 6. 7. 8. Viso Geral .............................................................................................................................. Mtodos Oferecidos ................................................................................................................... Informaes sobre o Webservice .................................................................................................. Interface do Webservice - Enviar Arquivo ..................................................................................... Interface do Webservice - Consultar Status .................................................................................... Interface do Webservice - Consultar Erros ..................................................................................... Especificaes Tcnicas ............................................................................................................. Dvidas e Questionamentos ........................................................................................................ 1 1 2 2 4 5 6 7

1. Viso Geral
Uma das fundaes do WebService a interoperabilidade entre plataformas. Isso significa que o WebService envia e recebe mensagens de uma forma padronizada. Tipicamente, o formato do protocolo SOAP . SOAP, originado do acrnimo ingls Simple Object Access Protocol, e em portugus Protocolo Simples de Acesso a Objetos, um protocolo para troca de informaes estruturadas em uma plataforma descentralizada e distribuda (Wikipdia). H vrias maneiras de utilizar (consumir) o WebService. Inmeras linguagens de computao buscam nveis ideais de abstrao para facilitar o uso do protocolo SOAP; o benefcio dessas abstraes que os programadores de aplicativos passam a focar mais nas regras do negcio do que nos rigores do protocolo SOAP. O WebService ArquivoECF tem por finalidade prover funcionalidades que automatizem o procedimento de envio de arquivos de cupons fiscais gerados por ECF (vide Instruo Nomativa n 015/2011/GAB/CRE/SEFIN/RO). Para isso, prev as funcionalidades de: envio de arquivos de cupons fiscais para processamento; consulta assncrona do resultado do processamento de arquivos; consulta assncrona de erro gerados pelo processamento de arquivos - procedures ( servios banco de dados);

2. Mtodos Oferecidos
A fim de prover as funcionalidades supracitadas sero oferecidos trs mtodos para uso pelos contribuintes: Wsenviararquivo(): Mtodo para enviar arquivo de cupons fiscais; Wsconsultarstatusarquivo() : Mtodo para consultar status do arquivo enviado; Wsconsultarerrosarquivo() : Mtodo para consulta de erros dos arquivos enviados;

Manual para Envio de Arquivo de Cupons Fiscais via WebService

3. Informaes sobre o Webservice

As requisies aos mtodos devem utilizar como protocolo de transporte o SSL e destinadas, quando em produo, ao endereo https://notalegal.sefin.ro.gov.br/contribuinte/webservices/NPJServices.jws?wsdl . Voc pode verificar os mtodos oferecidos digitando no seu navegador o link https://notalegal.sefin.ro.gov.br/ contribuinte/webservices/. Todas as mensagens trocadas com o servidor devem ser no protocolo SOAP verso 1.1, outros formatos sero recusados. As informaes referentes ao login e tipo de usurio devem estar dentro do elemento body. Cabe informar que o site da NOTA LEGAL RONDONIENSE , Mdulo Contribuinte, utiliza para a autenticao do login e senhas as mesmas do PORTAL DO CONTRIBUINTE. No caso de envio para processamento ( em produo ), o usurio/senha utilizados devem estar previamente cadastrados no Portal do Contribuinte Sefin RO (http://portal.intranet.sefin.ro.gov.br/PortalContribuinte/login.jsp) e possuir permisso para acesso rea restrita daquele portal e utilizao de seus servios. Essa permisso deve ser efetuada mediante emisso de documento, seguindo os procedimentos editados na pgina do Portal do Contribuinte, e encaminhado a agncia de renda de jurisdio do contribuinte. Mais informaes a respeito dos PROCEDIMENTOS PARA PORTAL DO CONTRIBUINTE clique: http:// portal.intranet.sefin.ro.gov.br/PortalContribuinte/help.jsp.

4. Interface do Webservice - Enviar Arquivo

Mtodo Wsenviararquivo() Este mtodo tem por finalidade fornecer ao contribuinte um meio de enviar os arquivos de cupons fiscais Secretaria da Finanas. Segue formatao padro SOAP: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:soapenv="http:// schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://DefaultNamespace"> <soapenv:Header/> <soapenv:Body> <def:Wsenviararquivo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <StringDoArquivo xsi:type="xsd:string">String</StringDoArquivo> <Usuario xsi:type="xsd:string">String</Usuario> <Senha xsi:type="xsd:string">String</Senha> <InscricaoEstadual xsi:type="xsd:string">String</InscricaoEstadual> <MesAnoReferencia xsi:type="xsd:string">String</MesAnoReferencia> <DataInicio xsi:type="xsd:string">String</DataInicio> <DataFim xsi:type="xsd:string">String</DataFim> </def:Wsenviararquivo> </soapenv:Body> </soapenv:Envelope>

Manual para Envio de Arquivo de Cupons Fiscais via WebService

Descrevendo os parmetros de entrada:

Tabela 1. Parmetros de Entrada do Mtodo Wsenviararquivo():

Campo StringDoArquivo Usuario Senha Inscrio Estadual Descrio Contedo do Arquivo em sequncia de string Login do usurio do Portal do Contribuinte Senha do Usurio do Portal do Contribuinte 14 dgitos da Inscrio Estadual do Contribuinte emissor dos arquivos - alinhado direita Data referncia do Arquivo - Formato: MM / AAAA Data Incio constante nos Arquivos enviados seguindo o formato: DD / MM / AAAA Data Final constante nos Arquivos enviados seguindo o formato: DD / MM / AAAA Tipo de Dados String String String String

MesAnoReferencia DataInicio

String String

DataFim

String

Tabela 2. Retorno (int ) do Mtodo Wsenviararquivo():

Retorno (int) -7 -6 -5 -4 -3 -2 -1 0 Maior que 0 (Zero) Observaes: O Ms/Ano de referncia e Data Inicio e Data Final tm que ser informados com a /. Todos os parmetros tm que ser informados como string. O protocolo retornado tem que ser armazenado para posteriores consultas ao status do arquivo. Descrio Ms de referncia maior do que o ms atual. O perodo informado est fora do Ms/Ano de referncia Data final maior do que a data inicial Ms/Ano de referncia no informado Data final no informada Data inicial no informada Falha de autenticao do CPF e senha Falha ao gravar o arquivo Protocolo do arquivo

Manual para Envio de Arquivo de Cupons Fiscais via WebService

5. Interface do Webservice - Consultar Status

Mtodo Wsconsultarstatusarquivo() Este mtodo tem por finalidade fornecer ao contribuinte um meio de consulta ao resultado do processamento dos arquivos de cupons fiscais enviados Secretaria da Finanas. O mtodo retorna o status do arquivo a partir de um protocolo informado. Esse protocolo adquirido atravs do retorno do mtodo WS Enviar Arquivo Abaixo sua formatao padro SOAP: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http:// schemas.xmlsoap.org/soap/envelope/" xmlns:def="http:// DefaultNamespace"><soapenv:Header/> <soapenv:Body> <def:Wsconsultarstatusarquivo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <CodigoArquivo xsi:type="xsd:long">String</CodigoArquivo> </def:Wsconsultarstatusarquivo> </soapenv:Body> </soapenv:Envelope> Descrevendo o parmetro de entrada:

Tabela 3. Parmetros de Entrada do Mtodo Wsconsultarstatusarquivo()

Campo CdigoArquivo Descrio Protocolo do arquivo retornado pelo mtodo Wsenviararquivo() Tipo de Dados String

Descrevendo os parmetros de retorno:

Tabela 4. Parmetros de Retorno do Mtodo Wsconsultarstatusarquivo()

Retorno (int) -2 -1 3 4 1 2 5 Descrio Protocolo no informado Arquivo no encontrado para o protocolo informado Arquivo processado Erro no processamento do arquivo Arquivo ainda no processado Arquivo em processamento Erro de leitura durante o processamento do arquivo.

Manual para Envio de Arquivo de Cupons Fiscais via WebService

6. Interface do Webservice - Consultar Erros

Mtodo Wsconsultarerrosarquivo() Este mtodo tem por finalidade fornecer ao contribuinte um meio de consulta dos errros gerados no processamento dos arquivos de cupons fiscais enviados Secretaria da Finanas. Abaixo sua formatao padro SOAP: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://DefaultNamespace"><soapenv:Header/> <soapenv:Body> <def:Wsconsultarerrosarquivo schemas.xmlsoap.org/soap/encoding/"> soapenv:encodingStyle="http://

<CodigoArquivo xsi:type="xsd:long">String</CodigoArquivo> </def:Wsconsultarerrosarquivo> </soapenv:Body> </soapenv:Envelope> Descrevendo o parmetro de entrada e retorno:

Tabela 5. Parmetros de Entrada do Mtodo Wsconsultarerrosarquivo()

Campo CdigoArquivo Descrio Protocolo do arquivo retornado pelo mtodo Wsenviararquivo() Tipo de Dados String

Tabela 6. Parmetros de Retorno do Mtodo Wsconsultarerrosarquivo()

Retorno -2 -1 -3 XML Com Erros Descrio Protocolo no informado Arquivo no encontrado para o protocolo informado Arquivo no possui erros XML com os erros

Segue exemplo de retorno do mtodo Wsconsultarerrosarquivo: <ns1:WsconsultarerrosarquivoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:ns1="http://DefaultNamespace"> <WsconsultarerrosarquivoReturn href="#id0"/> </ns1:WsconsultarerrosarquivoResponse> <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" soapenc:arrayType="xsd:anyType[2]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <multiRef href="#id1"/ > <multiRef href="#id2"/> </multiRef> <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" soapenc:arrayType="xsd:anyType[2]" xsi:type="soapenc:Array" xmlns:soapenc="http:// schemas.xmlsoap.org/soap/encoding/"> <multiRef xsi:type="soapenc:decimal">0</multiRef>

Manual para Envio de Arquivo de Cupons Fiscais via WebService <multiRef xsi:type="soapenc:string">Registro E02 no encontrado.</multiRef> </multiRef> <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" soapenc:arrayType="xsd:anyType[2]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <multiRef xsi:type="soapenc:decimal">0</multiRef> <multiRef xsi:type="soapenc:string">Registro E01 no encontrado.</multiRef> </multiRef>

7. Especificaes Tcnicas
Tabela 7. Propriedades da Interface
Property Name Url Definition Binding Soap Version Style Builder Value NPJServicesSoapBinding https://notalegal.sefin.ro.gov.br/contribuinte/webservices/NPJServices.jws?wsdl {https://notalegal.sefin.ro.gov.br/contribuinte/webservices/NPJServices.jws}NPJServicesSoapBinding SOAP 1.1 RPC Apache Axis version: 1.4 Built on Apr 22, 2006 (06:55:48 PDT)

Tabela 8. Estrutura do Arquivo WSDL

Name targetNamespace Value https://notalegal.sefin.ro.gov.br/ contribuinte/webservices/NPJServices.jws Vide Tabs. 1 e 2 - mtodo Wsenviararquivo Idem Vide Tabs. 3 e 4 - mtodo Wsconsultarstatusarquivo Idem Vide Tabs. 5 e 6 - mtodo Wsconsultarerrosarquivo Idem NPJServices NPJServicesSoapBinding NPJServicesService Type NA*

WsenviararquivoRequest WsenviararquivoResponse WsconsultarstatusarquivoRequest WsconsultarstatusarquivoResponse WsconsultarerrosarquivoRequest WsconsultarerrosarquivoResponse Port Binding Service

xsd:string Idem xsd:string Idem xsd:string Idem NA NA NA

xml version="1.0" encoding="UTF-8" *NA: No Aplicvel

Manual para Envio de Arquivo de Cupons Fiscais via WebService

8. Dvidas e Questionamentos
Em caso de necessidade de esclarecimentos tcnicos sobre este manual, dever ser utilizado o Fale Conosco do Portal da Nota Legal Rondoniense ( https://notalegal.sefin.ro.gov.br/notalegal/ ), com a identificao detalhada do problema ocorrido. As dvidas sero encaminhadas ao setor competente. Para o esclarecimento de dvidas sobre o Projeto Nota Legal Rondoniense, dever ser utilizado o Call Center da Secretaria de Finanas do Estado de Rondnia (0800-647 4700). Esta obra distribuda por meio da Licena Pblica Geral (Creative Commons): Atribuio/Uso No-Comercial/Vedada a Criao de Obras Derivadas / 3.0 / Brasil