Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais

Especificação

Produto

RM

Módulo

TOTVS Gestão Fiscal

Segmento Executor

Backoffice

Requisito/Story/Issue

FISCAL01-9799

Subtarefa

FISCAL01-10176

País

( x ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Objetivo

 Detalhar as alterações necessárias no modulo TOTVS Gestão Fiscal para a implementação a integração dos Eventos da EFD-REINF com os webservices (WS) TOTVS Service Soa (TSS)

WebService do TSS

Na integração com o TSS deverá ser utilizado o WS TSSWSREINF onde são disponibilizados os serviços abaixo.

Image Modified

A documentação do TSS encontra-se disponível no TDN e pode ser consultada através do link  http://tdn.totvs.com/display/TSS/WebService+-+TSSWSREINFAs parametrizações de integração com o TSS já estão disponíveis no parâmetro da Filial do modulo de Estoque nas etapas referentes à integração com o modulo módulo Fiscal.

Configurar Ambiente

Para Antes de utilizar o WS da EFD-REINF listados acima é necessário configurar o TSS utilizando os WS abaixo.

  • SpedAdm para configurar a filial que esta está emitindo os Eventos através do serviço AdmEmpresas. Este Serviço já está implementando implementado e disponível através da interface IFisSpedAdm do projeto RM.Fis.TSS.IService;
  • SpedCfgNfe para configurar o certificado digital através dos serviços CFGCERTIFICATECFGCERTIFICATEPFX ou CFGHSMEX. Este serviço já está implementado e disponível através do server FisCertificadoService do projeto RM.Fis.TSS.Service.

VALIDARSCHEMA

ENVIAREVENTOS

CONSULTAREVENTOS

Avisotip
titleCONSULTAREVENTOSSUGESTÃO

Para o serviço CONSULTAREVENTOS sugiro que seja utilizado o serviço SpedAdm.GetAdmEmpresasId para recuperar o código da entidade do TSS conforme documentação do TSS manter o padrão deverá ser criado uma interface (IFisTssWsReinf) no projeto RM.Fis.TSS.IService para o WS TSSWSREINF com os serviços WsValidarSchema, WsEnviarEventos, WsConsultarEventos. Esta interface deve ser implementada de forma semelhante a IFisSpedAdm. Esta prática evita que outros projetos tenham referências diretas ao TSS.

VALIDARSCHEMA

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameVALIDARSCHEMA
simpleViewerfalse
diagramWidth565
revision3

Através deste WS é realizada a validação da estrutura do XML do Evento conforme o schema disponibilizado pela RFB. Segue abaixo os parâmetros de entrada e saída do serviço. Para mais detalhes consulte a documentação do TSS http://tdn.totvs.com/x/

cZhSDg

Para este Serviço também é desnecessário a utilização do WS SpedCfgNfe

Processo R-9000 Exclusão de Evento

O Evento R-9000 será incluído através de um processo próprio com o nome "R-9000 Exclusão de Evento" e durante a inclusão o mesmo já será integrado com o TSS. Diferentemente dos demais Eventos o histórico deste deverá ser registrado no histórico do Evento pai vinculado.

Informações
titleEvento Principal

O Evento R-9000 é executado para outro Evento já existente, conduto para facilitar o entendimento vamos nos referir ao Evento Pai como Evento Principal

Durante a inclusão do Evento R-9000 deveram ser observadas o comportamentos dos campos abaixo.

  • Id. Evento Pai deverá ser exibido um lookup para cadastro do "Evento Principal", mas não poderá ser editado;
  • Tipo: será preenchido com o código do evento R-9000 e não deve ser editável;
  • Status: Receberá o status resultante da integração com o TSS. "Pendente" ou "Inconsistente".

Se o processo for executado com sucesso o "Evento Principal" terá o status alterado para "Pendente Exclusão" e um registro do R-9000 deverá ser incluído com status "Pendente". Em caso de erro deverá ser registrado um R-9000 "Inconsistente" e nada deverá ser alterado no "Evento Principal". Em ambos os casos um histórico deverá ser gravado no "Evento Principal".

Sempre que o "Evento Principal" estiver com o Status "Pendente Exclusão" ou "Excluído" o mesmo deverá apresentar um lookup para o Evento de Exclusão R-9000 no qual ele está associado.

O processo poderá ser executado em lote e através dos associados no Evento R-5011 para vários Eventos Periódicos simultaneamente (detalhes na especificação do R-5011).

Regras

  • Cada "Evento Principal" poderá ter somente um R-9000 associado e no caso de já existir um "Inconsistente" ou "Rejeitado" o mesmo deverá ser substituído.
  • O R-9000 poderá ser gerado somente para Eventos com Status "Autorizado";
  • O Evento R-9000 deve ser executado somente para os eventos do tipo: R-2010 a R-2070 e R-3010.

HUhZEg

Deck of Cards
historyfalse
idVALIDARSCHEMA
tabLocationleft
Card
id0
labelParâmetros de Entrada

Parâmetro

Tipo

Tam

Observação

AMBIENTEAlfanumérico1

Conforme definido para o Evento

2 – Produção Restrita Dados Reais.

3 - Produção Restrita Dados Fictícios.

CODIGO

Alfanumérico

10

Código do evento, conforme disponibilizado pela Receita Federal. R-1000, R-2010 etc.

ENTIDADE

Alfanumérico

 6

Código da entidade registrada no TSS.

Retornado pelo serviço AdmEmpresas

ID

Alfanumérico

100

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento.

USERTOKEN

Alfanumérico

6

Fixo TOTVS.

VERSAOAlfanumérico15

Versão do Evento.

Conforme definido nos parâmetros da EFD-REINF

 XML

BASE64Binary


Lista de XMLs dos eventos, conforme layout do Evento.

O layout de cada Evento está definido na especificação do mesmo.

Aviso
titleATENÇÃO

Cada requisição poderá ser realizada com no máximo 100 Eventos.

Card
id1
labelParâmetros de Saída

Parâmetro

Tipo

Tam

Observação

AMBIENTEAlfanumérico1

Ambiente do envio:

2 – Produção Restrita Dados Reais.

3 - Produção Restrita Dados Fictícios.

ENTIDADE

Alfanumérico

 6

Código da entidade registrada no TSS.

ERRO

Alfanumérico

6

Retorno Sefaz com a descrição da rejeição.

ID

Alfanumérico

100

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento.

STATUS

Booleano

1

Indicador de envio com sucesso.

VERSAOAlfanumérico15Versão do Evento.

ENVIAREVENTOS

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameENVIAREVENTOS
simpleViewerfalse
diagramWidth916
revision2

Através deste WS é realizado o envio dos XMLs dos Eventos ao TSS. Segue abaixo os parâmetros de entrada e saída do serviço. Para mais detalhes consulta a documentação do TSS http://tdn.totvs.com/x/EUJZEg

Deck of Cards
historyfalse
idVALIDARSCHEMA
tabLocationleft
Card
id0
labelParâmetros de Entrada

Parâmetro

Tipo

Tam

Pai

Observação

ENVIAREVENTOS

Estrutura

-

-

 -

REINFENVIO

Estrutura

ENVIAREVENTOS

 -

CABEC

Estrutura

-

REINFENVIO

-

AMBIENTE

Alfanumérico

1

CABEC

Conforme definido para o Evento

2 – Produção Restrita Dados Reais.

3 - Produção Restrita Dados Fictícios.

ENTIDADE

Alfanumérico

 6

CABEC

Código da entidade registrada no TSS.

Retornado pelo serviço AdmEmpresas

USERTOKEN

Alfanumérico

6

CABEC

Fixo TOTVS.

VERSAOAlfanumérico15CABEC

Versão do Evento.

Conforme definido nos parâmetros da EFD-REINF

EVENTOS

Estrutura

-

REINFENVIO

 Lista de Eventos

REINFENVIOEVENTOEstrutura-EVENTOS-

CODIGO

Alfanumérico

10

EVENTOS

Código do evento, conforme disponibilizado pela Receita Federal. R-1000, R-2010 etc.

ID

Alfanumérico

100

EVENTOS

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento.

XML

BASE64Binary


EVENTOS

Deverá ser enviado o XML que foi validado através do serviço VALIDARSCHEMA

Aviso
titleATENÇÃO
  • Cada requisição poderá ser realizada com no máximo 100 Eventos.
  • Só podem ser enviados os XML válidos, ou seja, aqueles que passaram pela validação de schema sem erros.
Card
id1
labelParâmetros de Saída

Parâmetro

Tipo

Tam

Observação

AMBIENTEAlfanumérico1

Ambiente do envio:

2 – Produção Restrita Dados Reais.

3 - Produção Restrita Dados Fictícios.

ENTIDADE

Alfanumérico

 6

Código da entidade registrada no TSS.

ERRO

Alfanumérico

6

Retorno Sefaz com a descrição da rejeição.

ID

Alfanumérico

100

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento.

STATUS

Booleano

1

Indicador de envio com sucesso.

VERSAOAlfanumérico15Versão do Evento.

CONSULTAREVENTOS

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameCONSULTAREVENTOS
simpleViewerfalse
diagramWidth573
revision1

Dica
titleCONSULTAREVENTOS

Para o serviço CONSULTAREVENTOS sugiro que seja utilizado o serviço SpedAdm.GetAdmEmpresasId para recuperar o código da entidade do TSS conforme documentação do TSS http://tdn.totvs.com/x/cZhSDg

Neste serviço é desnecessário a utilização do WS SpedCfgNfe

Através deste WS é realizada a consulta do XMLs dos Eventos no TSS. Segue abaixo os parâmetros de entrada e saída do serviço. Para mais detalhes consulta a documentação do TSS http://tdn.totvs.com/x/EkBZEg

Deck of Cards
historyfalse
idVALIDARSCHEMA
tabLocationleft
Card
id0
labelParâmetros de Entrada

Parâmetro

Tipo

Tam

Pai

Observação

CONSULTAREVENTOS

Estrutura

-

-

 -

REINFCONSULTA

Estrutura

-

-

 -

CABECEstrutura
REINFCONSULTA-

ID_ENT

Alfanumérico

 06

CABEC

Código da entidade registrada no TSS.

Retornado pelo serviço AdmEmpresas

RETORNAXMLLógico-CABECFixo true

USERTOKEN

Alfanumérico

06

CABEC

Fixo TOTVS.

EVENTOS

Estrutura

 -

REINFCONSULTA

Lista de ID dos Eventos

REINFID

Estrutura

-

EVENTOS

ID

Alfanumérico

100

REINFID

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento

Aviso
titleATENÇÃO

Cada requisição poderá ser realizada com no máximo 100 Eventos.

Card
id1
labelParâmetros de Saída

Parâmetro

Tipo

Tam

Pai

Observação

CONSULTAREVENTOSRESULT

Estrutura

-

-

 -

REINFRETCONSULTA

Estrutura

-

CONSULTAREVENTOSRESULT

-

CHAVE

Alfanumérico

36

REINFRETCONSULTA

Chave Evento.

CODEVENTO

Alfanumérico

10

REINFRETCONSULTA

Código Evento.

CODRECEITA

Alfanumérico

10

REINFRETCONSULTA

 Código da Receita

DETSTATUSAlfanumérico1REINFRETCONSULTADetalhe do evento, conforme disponibilizado pela Receita Federal.
DSRECEITAAlfanumérico30REINFRETCONSULTADescrição do Código Receita.

DTENTRADA

Date

8

REINFRETCONSULTA

Data Entrada Evento.

DTPROC

Date

8

REINFRETCONSULTA

Data Processamento Evento.

DTTRANSDate8REINFRETCONSULTAData Transação Evento.
HRENTRADAAlfanumérico8REINFRETCONSULTAHora Entrada Evento.
HRPROCAlfanumérico8REINFRETCONSULTAHora Processamento Evento.
HRTRANSAlfanumérico8REINFRETCONSULTAHora Transação Evento.
IDAlfanumérico100REINFRETCONSULTA

Identificador do evento.

Este identificador é gerado pelo ERP emissor do evento.

LOTEAlfanumérico32REINFRETCONSULTANúmero do Lote.
PROTOCOLOAlfanumérico40REINFRETCONSULTANúmero do Protocolo.
RECIBOAlfanumérico30REINFRETCONSULTANúmero do Recibo.
STATUSAlfanumérico1REINFRETCONSULTAStatus do documento no TSS.
VERSAOAlfanumérico8REINFRETCONSULTAVersão do Evento.

XMLEVENTO

Alfanumérico


REINFRETCONSULTA

Detalhes do xml do evento

Layout do Evento

O xml do Evento deverá ser gerado conforme abaixo.

Bloco de código
languagexml
titleExemplo R-1000
<?xml version="1.0" encoding="utf-8"?>
<Reinf>
  <evtExclusao id="???000000000000000000000000000000000">
    <ideEvento>{...}</ideEvento>
    <ideContri>{...}</ideContri>
    <infoExclusao>{...}</infoExclusao>
  </evtExclusao>
</Reinf>

Origem dos dados

Este evento será gerado com base nos dados do "Evento Principal" que esta sendo "excluído".

infoExclusao

Bloco de código
languagexml
titleinfoExclusao
<infoExclusao>
  <tpEvento>str123</tpEvento>
  <nrRecEvt>str1234000000000</nrRecEvt>
  <perApur>2019-01</perApur>
</infoExclusao>

Origem de dados

Elemento do XMLOrigemtpEvento

Informar o tipo de Evento que esta sendo excluído

Deve ser um dos eventos: R-2010 a R-2070 e R-3010.

nrRecEvt

Preencher com o número do recibo do "Evento Principal" que será excluído.

Protocolo do "Evento Principal" que esta sendo Excluído

perApurInformar o período de referência das informações no formato AAAA-MMAs demais estruturas não destacadas irão seguir o padrão geral dos eventos

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.