1

Manual para Envio de Arquivo deCupons Fiscais via WebService

GEINF - CRE - SEFIN ROVERSÃO 1.0

14/01/2012

Índice1. Visão Geral .............................................................................................................................. 12. Métodos Oferecidos ................................................................................................................... 13. Informações sobre o Webservice .................................................................................................. 24. Interface do Webservice - Enviar Arquivo ..................................................................................... 25. Interface do Webservice - Consultar Status .................................................................................... 46. Interface do Webservice - Consultar Erros ..................................................................................... 57. Especificações Técnicas ............................................................................................................. 68. Dúvidas e Questionamentos ........................................................................................................ 7

1. Visão GeralUma das fundações do WebService é a interoperabilidade entre plataformas. Isso significa que o WebServiceenvia e recebe mensagens de uma forma padronizada. Tipicamente, o formato do protocolo é SOAP .

SOAP, originado do acrônimo inglês Simple Object Access Protocol, e em português Protocolo Simples de Acessoa Objetos, é um protocolo para troca de informações estruturadas em uma plataforma descentralizada e distribuída(Wikipédia).

Há várias maneiras de utilizar (consumir) o WebService. Inúmeras linguagens de computação buscam níveis ideaisde abstração para facilitar o uso do protocolo SOAP; o benefício dessas abstrações é que os programadores deaplicativos passam a focar mais nas regras do negócio do que nos rigores do protocolo SOAP.

O WebService ArquivoECF tem por finalidade prover funcionalidades que automatizem o procedimento de enviode arquivos de cupons fiscais gerados por ECF (vide Instrução Nomativa nº 015/2011/GAB/CRE/SEFIN/RO).Para isso, prevê as funcionalidades de:

• envio de arquivos de cupons fiscais para processamento;

• consulta assíncrona do resultado do processamento de arquivos;

• consulta assíncrona de erro gerados pelo processamento de arquivos - procedures ( serviços banco de dados);

2. Métodos OferecidosA fim de prover as funcionalidades supracitadas serão oferecidos três métodos para uso pelos contribuintes:

• Wsenviararquivo(): Método para enviar arquivo de cupons fiscais;

• Wsconsultarstatusarquivo() : Método para consultar status do arquivo enviado;

• Wsconsultarerrosarquivo() : Método para consulta de erros dos arquivos enviados;

Manual para Envio de Arquivo deCupons Fiscais via WebService

2

3. Informações sobre o WebserviceAs requisições aos métodos devem utilizar como protocolo de transporte o SSL e destinadas, quando em produção,ao endereço https://notalegal.sefin.ro.gov.br/contribuinte/webservices/NPJServices.jws?wsdl .

Você pode verificar os métodos 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 versão 1.1, outros formatos serãorecusados. As informações referentes ao login e tipo de usuário devem estar dentro do elemento body. Cabe in-formar que o site da NOTA LEGAL RONDONIENSE , Módulo Contribuinte, utiliza para a autenticação do logine senhas as mesmas do PORTAL DO CONTRIBUINTE.

No caso de envio para processamento ( em produção ), o usuário/senha utilizados devem estar previamente cadas-trados no Portal do Contribuinte – Sefin RO (http://portal.intranet.sefin.ro.gov.br/PortalContribuinte/login.jsp) epossuir permissão para acesso à área restrita daquele portal e utilização de seus serviços. Essa permissão deve serefetuada mediante emissão de documento, seguindo os procedimentos editados na página do Portal do Contribu-inte, e encaminhado a agência de renda de jurisdição do contribuinte.

Mais informações a respeito dos PROCEDIMENTOS PARA PORTAL DO CONTRIBUINTE clique: http://portal.intranet.sefin.ro.gov.br/PortalContribuinte/help.jsp.

4. Interface do Webservice - Enviar ArquivoMétodo Wsenviararquivo()

Este método tem por finalidade fornecer ao contribuinte um meio de enviar os arquivos de cupons fiscais à Secre-taria da Finanças. Segue formatação padrão 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 deCupons Fiscais via WebService

3

Descrevendo os parâmetros de entrada:

Tabela 1. Parâmetros de Entrada do Método Wsenviararquivo():

Campo Descrição Tipo de Dados

StringDoArquivo Conteúdo do Arquivoem sequência de string

String

Usuario Login do usuário doPortal do Contribuinte

String

Senha Senha do Usuário doPortal do Contribuinte

String

Inscrição Estadual 14 dígitos da Inscrição Estadu-al do Contribuinte emissor dos

arquivos - alinhado à direita

String

MesAnoReferencia Data referência do Arqui-vo - Formato: MM / AAAA

String

DataInicio Data Início constante nos Ar-quivos enviados seguindo oformato: DD / MM / AAAA

String

DataFim Data Final constante nos Ar-quivos enviados seguindo oformato: DD / MM / AAAA

String

Tabela 2. Retorno (int ) do Método Wsenviararquivo():

Retorno (int) Descrição

-7 Mês de referência é maior do que o mês atual.

-6 O período informado está fo-ra do Mês/Ano de referência

-5 Data final é maior do que a data inicial

-4 Mês/Ano de referência não informado

-3 Data final não informada

-2 Data inicial não informada

-1 Falha de autenticação do CPF e senha

0 Falha ao gravar o arquivo

Maior que 0 (Zero) Protocolo do arquivo

Observações:

• O Mês/Ano de referência e Data Inicio e Data Final têm que ser informados com a /.

• Todos os parâmetros têm que ser informados como string.

• O protocolo retornado tem que ser armazenado para posteriores consultas ao status do arquivo.

Manual para Envio de Arquivo deCupons Fiscais via WebService

4

5. Interface do Webservice - Consultar StatusMétodo Wsconsultarstatusarquivo()

Este método tem por finalidade fornecer ao contribuinte um meio de consulta ao resultado do processamento dosarquivos de cupons fiscais enviados à Secretaria da Finanças.

O método retorna o status do arquivo a partir de um protocolo informado. Esse protocolo é adquirido através doretorno do método WS Enviar Arquivo

Abaixo sua formatação padrão 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/en-coding/">

<CodigoArquivo xsi:type="xsd:long">String</CodigoArquivo>

</def:Wsconsultarstatusarquivo>

</soapenv:Body>

</soapenv:Envelope>

Descrevendo o parâmetro de entrada:

Tabela 3. Parâmetros de Entrada do Método Wsconsultarstatusarquivo()

Campo Descrição Tipo de Dados

CódigoArquivo Protocolo do arquivo retornado pelométodo Wsenviararquivo()

String

Descrevendo os parâmetros de retorno:

Tabela 4. Parâmetros de Retorno do Método Wsconsultarstatusarquivo()

Retorno (int) Descrição

-2 Protocolo não informado

-1 Arquivo não encontrado para o protocolo informado

3 Arquivo processado

4 Erro no processamento do arquivo

1 Arquivo ainda não processado

2 Arquivo em processamento

5 Erro de leitura durante o processamento do arquivo.

Manual para Envio de Arquivo deCupons Fiscais via WebService

5

6. Interface do Webservice - Consultar ErrosMétodo Wsconsultarerrosarquivo()

Este método tem por finalidade fornecer ao contribuinte um meio de consulta dos errros gerados no processamentodos arquivos de cupons fiscais enviados à Secretaria da Finanças.

Abaixo sua formatação padrão SOAP:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-ins-tance" 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 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<CodigoArquivo xsi:type="xsd:long">String</CodigoArquivo>

</def:Wsconsultarerrosarquivo>

</soapenv:Body>

</soapenv:Envelope>

Descrevendo o parâmetro de entrada e retorno:

Tabela 5. Parâmetros de Entrada do Método Wsconsultarerrosarquivo()

Campo Descrição Tipo de Dados

CódigoArquivo Protocolo do arquivo retornado pelométodo Wsenviararquivo()

String

Tabela 6. Parâmetros de Retorno do Método Wsconsultarerrosarquivo()

Retorno Descrição

-2 Protocolo não informado

-1 Arquivo não encontrado para o protocolo informado

-3 Arquivo não possui erros

XML Com Erros XML com os erros

Segue exemplo de retorno do método Wsconsultarerrosarquivo:

<ns1:WsconsultarerrosarquivoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://DefaultNamespace"> <Wsconsultarerrosarqui-voReturn href="#id0"/> </ns1:WsconsultarerrosarquivoResponse> <multiRefid="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/enco-ding/" 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 deCupons Fiscais via WebService

6

<multiRef xsi:type="soapenc:string">Registro E02 não 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/"> <multiRefxsi:type="soapenc:decimal">0</multiRef> <multiRef xsi:type="soapenc:string">RegistroE01 não encontrado.</multiRef> </multiRef>

7. Especificações Técnicas

Tabela 7. Propriedades da Interface

Property Value

Name NPJServicesSoapBinding

Url Definition https://notalegal.sefin.ro.gov.br/contribu-inte/webservices/NPJServices.jws?wsdl

Binding {https://notalegal.sefin.ro.gov.br/contribuinte/web-services/NPJServices.jws}NPJServicesSoapBinding

Soap Version SOAP 1.1

Style RPC

Builder Apache Axis version: 1.4 Builton Apr 22, 2006 (06:55:48 PDT)

Tabela 8. Estrutura do Arquivo WSDL

Name Value Type

targetNamespace https://notalegal.sefin.ro.gov.br/contribuinte/webser-

vices/NPJServices.jws

NA*

WsenviararquivoRequest Vide Tabs. 1 e 2 - mé-todo Wsenviararquivo

xsd:string

WsenviararquivoResponse Idem Idem

WsconsultarstatusarquivoRequest Vide Tabs. 3 e 4 - métodoWsconsultarstatusarquivo

xsd:string

WsconsultarstatusarquivoResponse Idem Idem

WsconsultarerrosarquivoRequest Vide Tabs. 5 e 6 - métodoWsconsultarerrosarquivo

xsd:string

WsconsultarerrosarquivoResponse Idem Idem

Port NPJServices NA

Binding NPJServicesSoapBinding NA

Service NPJServicesService NA

xml version="1.0" encoding="UTF-8" *NA: Não Aplicável

Manual para Envio de Arquivo deCupons Fiscais via WebService

7

8. Dúvidas e QuestionamentosEm caso de necessidade de esclarecimentos técnicos sobre este manual, deverá ser utilizado o “Fale Conosco” doPortal da Nota Legal Rondoniense ( https://notalegal.sefin.ro.gov.br/notalegal/ ), com a identificação detalhadado problema ocorrido.

As dúvidas serão encaminhadas ao setor competente. Para o esclarecimento de dúvidas sobre o Projeto Nota LegalRondoniense, deverá ser utilizado o Call Center da Secretaria de Finanças do Estado de Rondônia (0800-647 4700).

Esta obra é distribuída por meio da Licença Pública Geral (Creative Commons): Atribuição/Uso Não-Comerci-al/Vedada a Criação de Obras Derivadas / 3.0 / Brasil™