Escolar Documentos
Profissional Documentos
Cultura Documentos
Manual de Integrao
Controle de Verses
Verso 1.0 Data 26/09/2012 Observao Verso Inicial do Documento, baseado nas regras j definidas e em utilizao no Recopi Paulista. Reviso com adio de tags opcionais adicionadas e outras correes. Reviso com adio de regras de compatibilidade. Reviso das mensagens de erro. Reviso do item Validaes Adicionais, na descrio dos campos obrigatrios por status. Atualizao do documento de acordo com a ocorrncia 108775. Atualizao do documento para adio das regras para Consulta Pblica e novas mensagens de erro.
ndice
1. 2. Introduo ................................................................................................................ 4 Consideraes Iniciais ............................................................................................. 5 2.1. Aspectos de Segurana ......................................................................................... 5 3. Web Services ........................................................................................................... 6 3.1. Pedido de Solicitao em Lote ............................................................................. 6 3.1.1. Validaes Adicionais ...................................................................................... 7 3.2. Incluso de Nota Fiscal ........................................................................................ 9 3.3. Confirmao do Status de Envio de Mercadoria ................................................ 10 3.3.1. Validaes Adicionais .................................................................................... 11 3.4. Controle de Estoque ........................................................................................... 12 3.4.1. Validaes Adicionais .................................................................................... 13 3.5. Consulta Pblica................................................................................................. 14 4. Ambientes .............................................................................................................. 16 Apndice 1 Erros Tratados............................................................................................. 17
1.
Introduo
Este documento tem por objetivo a definio das especificaes e critrios tcnicos necessrios para a integrao entre o Portal da Secretaria da Fazenda e os sistemas de informaes das empresas em relao ao sistema RECOPI Nacional.
2.
Consideraes Iniciais
Nesta verso, este documento considerado o Manual das Especificaes Web Service que sero disponibilizados para o sistema RECOPI Nacional. Tem por objetivo permitir o desenvolvimento e integrao dos sistemas utilizados pelas empresas com o sistema RECOPI Nacional. No obstante tratarem-se de especificaes tcnicas definidas para o Sistema RECOPI Nacional a serem aplicadas desde o incio de seu funcionamento, as mesmas podero ser aperfeioadas para futura implantao. O namespace a ser utilizado nos xmls enviados deve ser
"http://www.fazenda.sp.gov.br/". Outro ponto a ser notado que no processamento das tags XML so diferenciados caracteres maisculos de minsculos. Se a tag esperada CNPJ e for recebido cnpj, o sistema retornar o seguinte erro: 20 : Erro com Layout de Schema.
2.1.
Aspectos de Segurana
No sistema RECOPI Nacional, ser implantado desde o incio, a utilizao de Certificado Digital nos mesmos moldes dos envios da NFe.
3.
Web Services
Como regra geral, as tags de ErroStatus, ErroDescricao, ErroGeralStatus e ErroGeralDesc no devem ser valoradas nem necessitam ser inseridas no XML enviado. O Sistema RECOPI NACIONAL aceita somente certificados ICP que tenham CNPJ base igual ao do estabelecimento cuja requisio est sendo solicitada.
3.1.
Trata-se de Web Service desenvolvido para solicitao em lote de nmeros de registros de controle de operaes com o prvio reconhecimento do Fisco da no incidncia do imposto. Caso o arquivo possua erro no leiaute, o lote inteiro ser desconsiderado. Caso o leiaute esteja satisfeito, cada pedido de solicitao tratado individualmente, no afetando os outros pedidos no lote. A tag CodigoControle no deve ser valorada nem necessita ser inserida no XML enviado.
Campo ListaSolicitacoes Solicitacao IdInterno TipoOperacao CNPJOrigem CNPJOrigemUF CNPJDestino CNPJDestinoUF CFOP
Ele Raiz E E E E E E E E -
Tipo C C C C C C N
Ocor
Tam.
Para controle da empresa emissora, no utilizado pelo RECOPI Nacional Checar lista de valores vlidos. Sigla da UF do Estabelecimento Origem, apenas maisculas Sigla da UF do Estabelecimento de Destino, apenas maisculas
SL10 SL11
Importacao OrdemJudicial
E E
SL02 SL02
bool bool
0-1 0-1
SL12
NumeroDI
SL02
0-1
Valor booleano (true ou false) que indica se a operao de Importao Valor booleano (true ou false) que indica se a contraparte tem Ordem Judicial para no operar no RECOPI Nacional Nmero da Declarao de Importao. Usado somente no caso de Operao de Importao Elemento complexo
E E E E E E
N N
1-1 1-1 1-1 0-1 2 Cdigo do tipo de papel Quantidade em kilos Elemento complexo Nota Fiscal conforme descrito separadamente. Somente para retorno. Valor zero significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor vazio significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor vazio indica que o cdigo de controle no foi gerado por erro Somente para retorno. Valor zero significa sem erros. Marca erro para o envio integral. Somente para retorno. Valor vazio significa sem erros. Marca erro para o envio integral.
0-1
SL19
ErroDescricao
SL02
0-1
SL20
CodigoControle
SL02
0-1
SL21
ErroGeralStatus
SL01
0-1
SL22
ErroGeralDesc
SL01
0-1
NF06
DataSaida
NF01
0-1
NF07
Valor
NF01
1-1
O campo IdInterno (SL03) para controle da empresa, no sendo utilizado pelo sistema RECOPI Nacional. O campo TipoOperacao (SL04) somente aceita os valores: Valor
REMESSA RECEBIMENTO REMESSA INDUSTRIALIZACAO RECEBIMENTO INDUSTRIALIZACAO REMESSA ARMAZEM GERAL E DEPOSITO FECHADO RECEBIMENTO ARMAZEM GERAL E DEPOSITO FECHADO
Descrio
Operao entre empresas cadastradas. Operao de entrada. Operao de remessa com fins de industrializao entre empresas cadastradas. Operao de recebimento com fins de industrializao. Operao de remessa com fins de armazenamento entre empresas cadastradas. Operao de recebimento com fins de armazenamento.
Para efeito de compatibilidade com a verso do WebService do sistema Recopi Paulista, os valores abaixo tambm sero aceitos no campo TipoOperacao (SL04): Valor
INTERNA REMESSA INTERESTADUAL IMPORTACAO ENTRADA INTERESTADUAL INDUSTRIALIZACAO REMESSA INTERNA INDUSTRIALIZACAO REMESSA INTERESTADUAL INDUSTRIALIZACAO RECEBIMENTO INTERESTADUAL ARMAZEM REMESSA INTERNA Operao de recebimento interestadual com fins de industrializao. Operao de remessa interna com fins de armazenamento entre empresas cadastradas. ARMAZEM REMESSA INTERESTADUAL ARMAZEM RECEBIMENTO Operao de recebimento interestadual com fins de Operao de remessa interestadual com fins de armazenamento.
Descrio
Operao interna entre empresas cadastradas. Operao de remessa interestadual. Operao de importao. Operao de entrada interestadual. Operao de remessa interna com fins de industrializao entre empresas cadastradas. Operao de remessa interestadual com fins de industrializao.
armazenamento. Operao de remessa para empresa no cadastrada, mas com ordem judicial.
JUDICIAL RECEBIMENTO
Operao de remessa, com fins de armazenamento, para empresa no cadastrada, mas com ordem judicial.
Operao de recebimento, com fins de armazenamento, de empresa no cadastrada, mas com ordem judicial. Operao de remessa, com fins de industrializao, para empresa no cadastrada, mas com ordem judicial. Operao de recebimento, com fins de industrializao, de empresa no cadastrada, mas com ordem judicial.
3.2.
Trata-se de Web Service desenvolvido para prestao de informao em lote de nmeros de Nota Fiscais emitidas que esto associadas a operaes para as quais j foram gerados pelo sistema RECOPI Nacional, em momento anterior, nmeros de registros de controle.
Ele Raiz E E E E
Tipo N N
Ocor
Tam.
Descrio
20 Elemento complexo Nota Fiscal conforme descrito separadamente. Somente para retorno. Valor zero significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor vazio significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor zero significa sem erros. Marca erro para o envio integral. Somente para retorno. Valor vazio significa sem erros. Marca erro para o envio integral.
IN06
ErroDescricao
IN02
0-1
IN07
ErroGeralStatus
IN01
0-1
IN08
ErroGeralDescricao
IN01
0-1
3.3.
Trata-se de Web Service desenvolvido para informar em lote o status de envio de mercadorias que esto associadas a operaes para as quais j foram gerados pelo sistema RECOPI Nacional, em momento anterior, nmeros de registros de controle.
Ele Raiz E E E E E E
Tipo N C C -
Ocor
Tam.
Descrio
20 Checar lista de valores vlidos. Informao para Nota Fiscal de entrada de mercadoria. Data da entrada da mercadoria no estabelecimento. Informao de Nota Fiscal complementar, pode ser de devoluo ou para cobrana de imposto.
CF08 CF09 CF10 CF11 CF12 CF13 CF14 CF15 CF16 CF17 CF18 CF19
Numero Serie DataEmissao DataSaida DataEntrada Valor ListaItens ItemPapel CodigoPapel Quantidade Perda IdRemessa
E E E E E E E E E E E E
CF07 CF07 CF07 CF07 CF07 CF07 CF02 CF17 CF18 CF18 CF18 CF02
N N D D D N N N N N
1-1 1-1 1-1 0-1 0-1 1-1 0-1 1-1 1-1 0-1 0-1 Somente para o caso de confirmao do retorno de armazm ou industrializao. Justificativa para no Confirmao da Operao. Somente para retorno. Valor zero significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor vazio significa sem erros. Marca erro para a solicitao especfica. 2 Lista de Itens no caso de devoluo. Formato AAAA-MM-DD Formato AAAA-MM-DD Formato AAAA-MM-DD
CF20 CF21
Justificativa ErroStatus
E E
CF02 CF02
C N
0-1 0-1
CF22
ErroDescricao
CF02
0-1
10
CF23
ErroGeralStatus
CF01
0-1
CF24
ErroGeralDescricao
CF01
0-1
Somente para retorno. Valor zero significa sem erros. Marca erro para o envio integral. Somente para retorno. Valor vazio significa sem erros. Marca erro para o envio integral.
Descrio
Para aceite completo da entrega. Para aceite aps uma devoluo. Para cancelamento da solicitao antes da sada da mercadoria. Realizado pelo remetente.
Para devoluo parcial da entrega. Para devoluo total da entrega, neste caso no necessria a relao de itens.
Para informar parcela de importao. Para transformar a entrega de imune para com imposto devido. Para retornar a entrega. Realizado pelo remetente. Para informar parcela de retorno de armazm. Para informar parcela de retorno de industrializao. Podem ser informadas perdas no processo.
SEM CONFIRMACAO
SINISTRO
Para informar o sinistro da entrega, transformando em com imposto devido. Realizado pelo remetente.
11
DEVOLUCAO PARCIAL DEVOLUCAO TOTAL IMPORTACAO FRACIONADA IMPOSTO RETORNO RETORNO ARMAZEM (Aceite Automtico) RETORNO INDUSTRIALIZACA O (Aceite Automtico) RETORNO ARMAZEM (Aceite Manual) RETORNO INDUSTRIALIZACA O (Aceite Manual) SEM CONFIRMACAO SINISTRO
X X
Aceito
X (Retorno)
Aceito
X (Retorno)
Aceito
X (Retorno)
3.4.
Controle de Estoque
Trata-se de Web Service desenvolvido para informar em lote, a ttulo de prestao de informao dos Estoques, as quantidades, por tipo de papel, em um determinado perodo.
Campo ListaControleEstoque ControleEstoque CNPJ CNPJUF TipoInforme DataReferencia TipoDeclaracao Justificativa ListaItens
Ele Raiz E E E E E E E E
Tipo C C C C C C -
Ocor
Tam.
Descrio
1-1 1-1 1-1 1-1 1-1 0-1 1-1 Sigla da UF do Estabelecimento, apenas maisculas Checar lista de valores vlidos. Formato MMAAAA. Valores: NOVA ou CORRETIVA. Somente para o caso do TipoDeclaracao ser CORRETIVA Lista de itens no estoque
12
E E E E E
N N N C 1-1 1-1 0-1 0-1 Somente para informe do tipo TRANSFORMACAO. Somente para informe do tipo PUBLICACAO. Valores: LIVRO ou JORNAL. Somente para informe do tipo PUBLICACAO. Somente para informe do tipo PUBLICACAO. Somente para retorno. Valor zero significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor vazio significa sem erros. Marca erro para a solicitao especfica. Somente para retorno. Valor zero significa sem erros. Marca erro para o envio integral. Somente para retorno. Valor vazio significa sem erros. Marca erro para o envio integral.
E E E
C N N
CE18
ErroDescricao
CE02
0-1
CE19
ErroGeralStatus
CE01
0-1
CE20
ErroGeralDescricao
CE01
0-1
Descrio
Informe da quantidade de estoque Informe de papel tributado utilizado na impresso de livros, jornais e peridicos.
PAPEL IMUNE
Informe de papel imune utilizado em finalidade diversa da impresso de livros, jornais e peridicos.
Informe de livros, jornais e peridicos. Informe de resduos, perdas e outros eventos. Informe de transformaes de tipos de papel. Informe de envios para industrializao. Informe de recebimentos de industrializao.
13
Valor
NOVA
Descrio
Insero de novo informe para um determinado tipo e data de referncia. Se a referncia da declarao estiver encerrada, o campo Justificativa (CE08) obrigatrio.
CORRETIVA
Correo de um informe para um determinado tipo e data de referncia. Se a referncia da declarao estiver encerrada, o campo Justificativa (CE08) obrigatrio.
Descrio
Neste caso o campo ISBNISSNTitulo (CE15) deve receber a informao do ISBN
JORNAL
Para o caso de se tratar de jornal ou peridico, neste caso o campo ISBNISSNTitulo (CE15) dever receber a informao do ISSN ou ttulo na falta do primeiro.
3.5.
Consulta Pblica
Trata-se de Web Service desenvolvido para informar em lote, a ttulo de informao a situao do Estabelecimento no sistema Recopi Nacional.
# CP01 CP02 CP03 CP04 CAMPO ListaConsultaPublica ELE RAIZ PAI CP01 CP02 CP03 50 1 14 TIPO OCOR. TAM DEC. Tag Raiz Elemento Complexo Elemento Complexo CNPJ do estabelecimento a ser consultado UF do Estabelecimento a ser consultado, CP05 CP06 UF Retorno E E CP03 CP03 1 0 2 apenas maisculas Mensagem de retorno da consulta Somente para retorno. Valor zero significa sem erros. Marca erro para a solicitao CP07 ErroStatus E CP03 0 especfica. Somente para retorno. Valor vazio significa CP08 ErroDescricao E CP03 0 sem erros. Marca erro para a solicitao Descrio
14
especfica. Somente para retorno. Valor zero significa CP09 ErroGeralStatus E CP01 0 sem erros. Marca erro para o envio integral Somente para retorno. Valor vazio significa CP10 ErroGeralDescricao E CP01 0 sem erros. Marca erro para o envio integral
15
4.
Ambientes
Para fins de homologao, o Web Service do RECOPI pode ser acessado atravs da URL: https://webhomolog.fazenda.sp.gov.br/recopiws/recopi.asmx
Para ambiente de produo, o Web Service do RECOPI pode ser acessado atravs da URL: https://webservices.fazenda.sp.gov.br/recopiws/recopi.asmx
16
30
Sem autorizao para realizar operaes no CNPJ do Certificado. Operaes em aberto Remetente. Operaes em aberto Destinatrio. Cdigo de controle invlido. Status invlido para operao solicitada. Tipo de operao invlido. Favor Preencher a Quantidade a Devolver para a Devoluo para pelo menos um Tipo de Papel. A Quantidade de Papel a Devolver maior que a Quantidade de Papel Cadastrada. Favor Corrigir o Valor. Favor Preencher o Valor da Nota Fiscal da Devoluo. Favor Preencher a Data de Sada da Mercadoria. Nota Fiscal e Srie j cadastradas. Favor corrigir os valores. Favor Preencher a Data de Entrada da Mercadoria. Favor Preencher a Quantidade A Despachar para pelo menos um Tipo de Papel. A Quantidade de Papel A Despachar maior que a Quantidade de Papel Disponvel. Favor Corrigir o Valor. Favor Preencher a Quantidade de Resduos ou Perdas para pelo menos um Tipo de Papel. A Quantidade de Papel de Resduos ou Perdas maior que a Quantidade de Papel Disponvel. Favor Corrigir o Valor. Favor Preencher o Valor da Nota Fiscal. Favor Preencher a Justificativa para No Confirmao.
9403
9406
9407
9411
9412 9413
9416 9419
17
Data invlida. Favor corrigir a data. Favor Preencher a Quantidade Atual para Todos os Tipos de Papel apresentados. Favor Preencher o Cdigo ISBN/ISSN ou Ttulo do Tipo de Papel. Favor Preencher a Justificativa
Favor Preencher o Valor da Nota Fiscal. Favor Preencher a Data de Sada da Mercadoria. Favor Preencher a Data de Entrada da Mercadoria. Favor Preencher a Declarao de Importao
9611
Favor Preencher o Valor da Nota Fiscal Complementar. Favor Preencher o Valor da Nota Fiscal do Retorno. Favor Preencher a Data de Entrada da Mercadoria para o Retorno. Favor Preencher a Quantidade A Receber para pelo menos um Tipo de Papel. A Quantidade de Papel A Receber maior que a Quantidade de Papel Disponvel. Favor Corrigir o Valor. Favor Preencher a Quantidade de Resduos ou Perdas para pelo menos um Tipo de Papel. A Quantidade de Papel de Resduos ou Perdas maior que a Quantidade de Papel Disponvel. Favor Corrigir o Valor. Favor Preencher o Valor da Nota Fiscal do Transporte. Sua situao atual no sistema {0}, com isso no ser possvel o cadastro de Nova Operao. Consulte o Menu Operaes Em Aberto para identificar possveis operaes que esto gerando bloqueio ou contate o Fisco responsvel para obter mais detalhes. O CNPJ Contraparte invlido. Favor conferir o nmero. O CNPJ Contraparte no se encontra cadastrado no RECOPI Nacional. A operao no pode ser realizada. A situao atual da Contraparte no permite realizar esta operao. Favor Preencher a Quantidade do Tipo de
9614
9615
9617
9618
9619
9620
9623 9624
A data preenchida est em formato invlido. O campo Quantidade (CE13) est vazio para o envio de controle de estoque. O campo ISBNISSNTitulo (CE15) est vazio para o envio de controle de estoque. O campo Justificativa (CE08) est vazio para o envio de controle de estoque CORRETIVA. O campo Valor (NF07) est vazio para o envio de Notas Fiscais. O campo DataSaida (NF06) est vazio para o envio de Notas Fiscais. O campo DataEntrada (NF05) est vazio para o envio de Notas Fiscais. O campo NumeroDI (SL12) est vazio para um envio de pedido de solicitao em Lote de uma Operao de Importao. O campo Valor (CF13) est vazio para uma confirmao do Status de Envio de Imposto Devido. O campo Valor (CF13) est vazio para uma confirmao do Status de Envio de Retorno de Mercadoria. O campo DataEntrada (CF12) est vazio para uma confirmao do Status de Envio de Retorno. O campo Quantidade (CF17) est vazio para uma confirmao do Status de Envio de Recebimento. O valor do campo Quantidade (CF17) maior do que possvel para uma confirmao do Status de Envio de Recebimento. O campo Perda (CF18) est vazio para uma confirmao do Status de Envio de Recebimento. O valor do campo Perda (CF18) maior do que possvel para uma confirmao do Status de Envio de Recebimento. O campo Valor (CF13) est vazio para uma confirmao do Status de Envio. Sua situao atual no permite o cadastro de Novas Operaes. Verificar possveis bloqueios.
9625 9627
9628 9630
O CNPJ da Contraparte preenchido est invlido. Operaes no mesmo Estado somente so permitidas entre Estabelecimentos cadastrados no Recopi Nacional. A situao atual da Contraparte no permite o cadastro de Novas Operaes. O campo Quantidade (SL16) est vazio para
18
9632
9634
Papel. A quantidade do Tipo de Papel {0} ultrapassou a quantidade credenciada {1} do {2}. Favor alterar a quantidade. Favor Preencher a Quantidade do Sinistro para pelo menos um Tipo de Papel. A Quantidade de Papel A Sinistrar maior que a Quantidade de Papel Disponvel. Favor Corrigir o Valor. Nota Fiscal e Srie j cadastradas. Favor corrigir os valores. Erro no processamento. Contate o Suporte Tcnico. A caracterstica desse registro indica tratar-se de uma Operao com natureza Ordem Judicial. Nesse caso favor preencher o campo Ordem Judicial com valor SIM. Campo obrigatrio ausente do XML. Sistema indisponvel. Para operao Importao os CNPJs Origem e Destino devem ser os mesmos. CFOP invlido. Tipo de Papel invlido. O conjunto informado j foi cadastrado. A incluso no possvel. No foi possvel realizar a declarao de estoque para um ou mais papis inativos Requisio Invlida para Estoque Requisio Invlida para Operao A UF <UF> No aderiu ao Recopi Nacional A UF <UF> aderiu ao Recopi Nacional, Porm no h credenciamento registrado nesta UF para o CNPJ Consultado O CNPJ consultado pertence a estabelecimento devidamente credenciado junto ao Sistema Recopi Nacional para a UF <UF> e sua situao atual <situao>
9635
40003
um pedido de Solicitao em Lote. O valor do campo Quantidade (SL16) maior do que possvel para um pedido de Solicitao em Lote. O campo Quantidade (CF17) est vazio para uma confirmao do Status de Envio de Sinistro. O valor do campo Quantidade (CF17) maior do que possvel para uma confirmao do Status de Envio de Sinistro. As informaes da Nota Fiscal enviadas j foram cadastradas. Problemas de comunicao com a Receita Federal ou com o CADESP. Uma Operao de Recebimento s pode ocorrer entre Estabelecimentos de Estados diferentes, ou para Estabelecimentos de Estados iguais com Natureza de Ordem Judicial. Faltou preenchimento de algum campo obrigatrio no arquivo enviado. Sistema Em Manuteno. Os CNPJs Origem e Destino enviados so diferente, portanto no pode se tratar de uma Operao de Importao. O valor do campo CFOP (SL09) no vlido para a Operao Enviada. O valor do campo Cdigo do Papel (SL15) no vlido para a Operao Enviada. Os dados enviados para controle de estoque j foram cadastrados no sistema. Um ou mais papeis enviados no arquivo esto inativos e a operao no possvel. O arquivo enviado possui uma requisio invlida para aes de Estoque. O arquivo enviado possui uma requisio invlida para aes de Operao. A UF do Estabelecimento consultado no aderiu ao Recopi Nacional. A UF do Estabelecimento consultado aderiu ao Recopi Nacional mas o Estabelecimento no se credenciou. O Estabelecimento consultado est credenciado.
19