ER_Especificação_S_5012

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	TOTVS AUTOMAÇÃO FISCAL	Módulo	SIGATAF
Segmento Executor	Serviço e Jurídico
Projeto	eSocial 2.1	IRM	PCREQ-5227
Requisito	PCREQ-7877	Subtarefa	PDR_SER_TAF002-110
Chamado
Release de Entrega Planejada	11.80.16
País	( x ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________.
Outros

Objetivo

Implementar Evento S-5012 (Informações do IRRF Consolidadas por contribuinte) publicadas pelo fisco no manual de orientação do eSocial Versão 2.1, Julho de 2015.

Definição da Regra de Negócio

Desenvolver um novo cadastro referente ao evento S-5012 do e-social, que permita inserção de informações do módulo de RH, referente a Informações das Contribuições Sociais Consolidadas por Contribuinte, implementando as regras de validação existentes no manual do e-Social versão 2.1.
Para o desenvolvimento da rotina, será necessário a criação das seguintes tabelas: T0G e T0H.
Deve-se criar uma aba para separar os campos de protocolo de transmissão.
Fazer todas as validações dos campos da rotina.
A rotina não gera XML.

<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.

Rotina	Tipo de Operação	Opção de Menu	Regras de Negócio
TAFA426	Inclusão	Atualizações -> Eventos eSocial ->	-

Tabelas Utilizadas

T0G - Informações Relativas ao Imposto de Renda Retido na Fonte.
T0H - Informações consolidadas do IRRF por código de Receita - CR.

Protótipo de Tela

Protótipo 01

Opcional

Fluxo do Processo

Diagrama – Caso de Uso

Diagrama – Atividades

Opcional

Dicionário de Dados

Arquivo ou Código do Script: T0G - Informações relativas ao Imposto de Renda Retido na Fonte.

Índice	Chave
01	T0G_FILIAL + T0G_ID + T0G_VERSAO
02	T0G_FILIAL + T0G_PERAPU + T0G_ATIVO
03	T0G_FILIAL + T0G_PROTUL + T0G_ATIVO
04	T0G_FILIAL + T0G_ID + T0G_ATIVO

Campos de Controle interno do sistema

Campo	T0G _FILIAL
Tipo	C
Grupo de Campos	033
Ordem	01
Tamanho	02
Decimal
Titulo	Filial
Descrição	Filial
Picture	@!
Valid
Usado	Não
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o código da filial referente ao cadastro.

Campo	T0G _ID
Tipo	C
Grupo de Campos
Ordem	02
Tamanho	6
Decimal
Titulo	ID
Descrição	Identificador do registro
Picture	@!
Valid
Usado	Sim, Não Obrigatório
Inic. Padrão	GetSx8Num("T0G","T0G_ID")
Propriedade	Microsiga
Browse	Sim
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o código de identificação do registro. Este código é controlado internamente pelo sistema de forma incremental e único por filial.

Campo	T0G_VERSAO
Tipo	C
Grupo de Campos	078
Ordem	03
Tamanho	14
Decimal
Titulo	Id. Ver. Reg
Descrição	Id.da versão do Registro
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo a identificação da versão do registro. Será composto por Data + Hora da ação (Inclusão/Alteração/Exclusão).

Campo	T0G _STATUS
Tipo	C
Grupo de Campos	079
Ordem	04
Tamanho	1
Decimal
Titulo	Status Reg.
Descrição	Status do registro
Picture	@!
Valid
Usado	Não, Não obrigatório
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo o status do registro: (Vazio) = Registro Novo 0 = Registro Válido (integração) 1 = Registro invalido (integração) 2 = Registro transmitido 3 = Registro transmitido com inconsistência(s) 4 = Registro transmitido válido 6 = Aguardando Transmissão Evento Exclusão 7 = Evento de exclusão Transmitido 9 = Em Processamento

Campo	T0G _EVENTO
Tipo	C
Grupo de Campos	081
Ordem	05
Tamanho	1
Decimal
Titulo	Id. Evento
Descrição	Identificação do Evento
Picture	@!
Valid
Usado	Sim, Não obrigatório
Inic. Padrão	"I"
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box	I=Inclusão;A=Alteração;E=Exclusão
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo a identificação do evento. Deve ser preenchido com: I=Inclusão A=Alteração E=Exclusão

Campo	T0G _ATIVO
Tipo	C
Grupo de Campos	082
Ordem	06
Tamanho	1
Decimal
Titulo	Reg. Ativo?
Descrição	Registro Ativo?
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão	"1"
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo se o registro está ativo: 1 = Sim 2 = Não

Campos de Controle por usuário (Campos ativos na tela)

Campo	T0G _PERAPU
Tipo	C
Grupo de Campos
Ordem	07
Tamanho	06
Decimal
Titulo	Per. Apuração
Descrição	Período Apuração
Picture	@R 9999-99
Valid	XFUNVldUni("T0G ",2,M->T0G_PERAPU)
Usado	Sim, Obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Indicativo de período de apuração.

Campo	T0G _NATINF
Tipo	C
Grupo de Campos
Ordem	08
Tamanho	1
Decimal
Titulo	Nat da Infor
Descrição	Natureza da informação
Picture	@!
Valid	Pertence(" 123")
Usado	Sim, Obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box	1=Informação parcial do evento S-4000; 2=Informação final do evento S-4000; 3=Informação final do evento S-1299
Consulta Padrão
Help de Campo	Deve representar neste campo o Natureza da informação, conforme opções a seguir: 1 - Informação parcial, ou seja, anterior ao fechamento dos eventos periódicos, originada a partir da solicitação do contribuinte através do evento S-4000; 2 - Informação final, ou seja, posterior ao fechamento dos eventos periódicos, originada a partir da solicitação do contribuinte através do evento S-4000; 3 - Informação final, ou seja, posterior ao fechamento dos eventos periódicos, vinculada ao fechamento dos eventos periódicos efetuado através do evento S-1299.

Campo	T0G_IDARQB
Tipo	C
Grupo de Campos
Ordem	09
Tamanho	6
Decimal
Titulo	Id Rec Arq
Descrição	Id do Recibo do Arq.
Picture	@!
Valid	XFUNVldCmp("CUO",,,,2,.F.)
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão	CUO
Help de Campo	Deve representar neste campo o ID do registro do evento S-4000 ou S-1299 selecionado na consulta padrão.

Campo	T0G_NRARQB
Tipo	C
Grupo de Campos
Ordem	10
Tamanho	220
Decimal
Titulo	Nr Rec Arq
Descrição	Número do Recibo do Arq.
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão	IF(!INCLUI.AND.!EMPTY(T0G->T0G_IDARQB),POSICIONE("CUO",4, xFilial("CUO")+T0G->T0G_IDARQB+"1","CUO->CUO_PROTUL"),"")
Propriedade	Microsiga
Browse	Sim
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o Número de Recibo do registro do evento S-4000 ou S-1299 selecionado na consulta padrão.

Campo	T0G_INDEXI
Tipo	C
Grupo de Campos
Ordem	11
Tamanho	1
Decimal
Titulo	Ind. Ex. Val
Descrição	Ind. de Ex. de Valores
Picture	@!
Valid	Pertence(" 123")
Usado	Sim, Obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box	1=Há info. de bases e contrib. sociais;2=Há mov., porém não há info. De bases e contrib. sociais;3=Não há mov. na competência
Consulta Padrão
Help de Campo	Indicativo de existência de valores de bases e de contribuições sociais, conforme opções a seguir: 1 - Há informações de bases e contribuições sociais; 2 - Há movimento, porém não há informações de bases e contribuições sociais; 3 - Não há movimento na competência.

Campo	T0G_OBSERV
Tipo	M
Grupo de Campos
Ordem	12
Tamanho	255
Decimal
Titulo	Observação
Descrição	Observação sobre o Evento
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve informar o texto fixo. As informações desse evento são resultantes de pedido de consulta, com as seguintes características: a) Não substitui o fechamento dos eventos periódicos (S-1299); b) Refletem a situação do momento de geração da consulta.

Aba Protocolo de Transmissão

Campo	T0G_PROTUL
Tipo	C
Grupo de Campos	080
Ordem	13
Tamanho	44
Decimal
Titulo	Últ. Prot.
Descrição	Prot. Última Transmissão
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo o protocolo da última transmissão do registro.

Gatilhos:

Campo	T0G_IDARQB
Ctr. Domínio	T0G_NRARQB
Sequencia	001
Regra	CUO_PROTUL
Tipo	Posicionamento
Seek	S
Alias Pesq.	CUO
Ordem Pesq	4
Chave	xFilial("CUO")+M->T0G_IDARQB+"1"

Consulta padrão: CUO - Fechamento dos Eventos Periódicos

Consulta	CUO
Descrição	Fech. dos Evts Periód
Tabela	CUO
Habilitar botão de inclusão / Habilitar botão de alteração	Sim
Filtro	CUO_ATIVO=="1"
Retorno	CUO_ID

Índices da consulta

Ordem	Descrição
01	ID
03	Número de Recibo

Colunas

Ordem	Descrição	Expressão	Id. Orig.
01	ID	CUO_ID	POR
02	Número de Recibo	CUO_PROTUL	POR

Relacionamento :

Tabela Dom. Pai	CUO
Exp. Domínio	CUO_ID
Exp. Contr. Domínio	T0G_IDARQB
Tipo Liga. Domínio	1
Tipo Liga Contra Domin.	N

Arquivo ou Código do Script: T0H - Informações consolidadas do IRRF por código de Receita - CR.Origem S-5002.

Índice	Chave
01	T0H_FILIAL + T0H_ID + T0H_VERSAO + T0H_PERAPU + T0H_IDCODR
02	T0H_FILIAL + T0H_IDCODR

Campo	T0H_FILIAL
Tipo	C
Grupo de Campos	033
Ordem	01
Tamanho	02
Decimal
Titulo	Filial
Descrição	Filial
Picture	@!
Valid
Usado	Não, Não Obrigatório
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o código da filial referente ao cadastro.

Campo	T0H_ID
Tipo	C
Grupo de Campos
Ordem	02
Tamanho	6
Decimal
Titulo	ID
Descrição	Identificador do registro
Picture	@!
Valid
Usado	Não, Não Obrigatório
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o código de identificação do registro. Este código é controlado internamente pelo sistema de forma incremental e único por filial.

Campo	T0H_VERSAO
Tipo	C
Grupo de Campos	078
Ordem	03
Tamanho	14
Decimal
Titulo	Id. Ver. Reg
Descrição	Id.da versão do Registro
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Campo de uso interno do sistema. Deve representar neste campo a identificação da versão do registro. Será composto por Data + Hora da ação Inclusão/Alteração/Exclusão).

Campo	T0H_IDCODR
Tipo	C
Grupo de Campos
Ordem	04
Tamanho	06
Decimal
Titulo	Id. Cód. Rec.
Descrição	Id. Código da Receita
Picture	@!
Valid	XFUNVldCmp("C80",,,,1,.F.)
Usado	Sim, Obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão	C80
Help de Campo	Deve representar nesse campo o id do código da receita relativo ao imposto de renda.

Campo	T0H_DCODRE
Tipo	C
Grupo de Campos
Ordem	05
Tamanho	220
Decimal
Titulo	Desc Cod Rec
Descrição	Descrição do Código da Receita
Picture	@!
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão	Iif(!INCLUI .and. !Empty(T0H->T0H_IDCODR),Posicione("C80",1,xFilial("C80")+T0H->T0H_IDCODR,"C80_CODIGO+' - '+C80_DESCRI"),"")
Propriedade	Microsiga
Browse	Sim
Visual	Visualizar
Contexto	Virtual
Combo Box
Consulta Padrão
Help de Campo	Deve representar nesse campo a descrição do código da receita relativo ao imposto de renda.

Campo	T0H_PERAPU
Tipo	C
Grupo de Campos
Ordem	06
Tamanho	6
Decimal
Titulo	Per Apuração
Descrição	Período Apuração
Picture	@R 9999-99
Valid
Usado	Não, Não obrigatório
Inic. Padrão
Propriedade	Microsiga
Browse	Não
Visual	Visualizar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Informar o mês/ano (formato AAAA-MM) de referência das informações, se {indApuracao} for igual a [1], ou apenas o ano (formato AAAA), se {indApuracao} for igual a [2]

Campo	T0H_VRCOCR
Tipo	C
Grupo de Campos
Ordem	07
Tamanho	14
Decimal	2
Titulo	Vlr CR
Descrição	Valor do Código de Receita
Picture	@E 999,999,999,999.99
Valid
Usado	Sim, Não obrigatório.
Inic. Padrão
Propriedade	Microsiga
Browse	Sim
Visual	Alterar
Contexto	Real
Combo Box
Consulta Padrão
Help de Campo	Deve representar neste campo o valor correspondente ao Código de Receita - CR apurado.

Relacionamento :

Tabela Dom. Pai	T0G
Exp. Domínio	T0G_ID+T0G_VERSAO+T0G_PERAPU
Exp. Contr. Domínio	T0H_ID+T0H_VERSAO+T0H_PERAPU
Tipo Liga. Domínio	1
Tipo Liga Contra Domin.	N

Tabela Dom. Pai	C80
Exp. Domínio	C80_ID
Exp. Contr. Domínio	T0H_IDCODR
Tipo Liga. Domínio	1
Tipo Liga Contra Domin.	N

Gatilho

Campo

T0H_IDCODR

Ctr. Domínio

T0H_DCODRE

Sequencia

001

Regra

C80->C80_DESCRI

Tipo

Posicionamento

Seek

S

Alias Pesq.

C80

Ordem Pesq

1

Chave

xFilial('C80') + M->T0H_IDCODR

Consulta padrão: C80 - Código da Receita

Consulta	C80
Descrição	Código da Receita
Tabela	C80
Habilitar botão de inclusão / Habilitar botão de alteração	Sim
Filtro	!EMPTY(C80_VALIDA)
Retorno	C80_ID

Índices

Ordem	Descrição
01	ID
02	Descrição
03	Código

Colunas

Ordem	Descrição	Expressão	Id. Orig.
01	ID	C80_ID	POR
02	Código	C80_CODIGO	POR
03	Descrição	C80_DESCRI	POR

Campo

T0G_IDARQB

Ctr. Domínio

T0G_NRARQB

Sequencia

001

Regra

CUO_PROTUL

Tipo

Posicionamento

Seek

S

Alias Pesq.

CUO

Ordem Pesq

4

Chave

xFilial("CUO")+M->T0G_IDARQB+"1"

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

Descrição	Configurações de Planejamento
Tipo	Consulta Padrão
Tabela	“AMB”
Índice	“Código”
Campo	“Código”; ”Descrição”
Retorno	AMB->AMB_CODIGO

(Opcional)

Estrutura de Menu

<Informações utilizadas na linha Datasul>.

Procedimentos

Procedimento
Descrição	(Max 40 posições)	(Max 40 posições)	(Max 40 posições)
Módulo
Programa base
Nome Menu	(Max 32 posições)	(Max 32 posições)	(Max 32 posições)
Interface	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex
Registro padrão	Sim	Sim	Sim
Visualiza Menu	Sim/Não	Sim/Não	Sim/Não
Release de Liberação

Programas

Programa
Descrição	(Max 40 posições)	(Max 40 posições)	(Max 40 posições)
Nome Externo
Nome Menu/Programa	(Max 32 posições)	(Max 32 posições)	(Max 32 posições)
Nome Verbalizado[1]	(Max 254 posições)	(Max 254 posições)	(Max 254 posições)
Procedimento
Template	(Verificar lista de opções no man01211)	(Verificar lista de opções no man01211)	(Verificar lista de opções no man01211)
Tipo[2]	Consulta/Manutenção/ Relatório/Tarefas	Consulta/Manutenção/ Relatório/Tarefas	Consulta/Manutenção/ Relatório/Tarefas
Interface	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex
Categoria[3]
Executa via RPC	Sim/Não	Sim/Não	Sim/Não
Registro padrão	Sim	Sim	Sim
Outro Produto	Não	Não	Não
Visualiza Menu	Sim/Não	Sim/Não	Sim/Não
Query on-line	Sim/Não	Sim/Não	Sim/Não
Log Exec.	Sim/Não	Sim/Não	Sim/Não
Rotina (EMS)
Sub-Rotina (EMS)
Localização dentro da Sub Rotina (EMS)
Compact[4]	Sim/Não	Sim/Não	Sim/Não
Home[5]	Sim/Não	Sim/Não	Sim/Não
Posição do Portlet[6]	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right
Informar os papeis com os quais o programa deve ser vinculado

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.

Código Papel	(máx 3 posições)
Descrição em Português*
Descrição em Inglês*

[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.

[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante

[3] Categorias são obrigatórias para os programas FLEX.

[4] Obrigatório quando o projeto for FLEX

[5] Obrigatório quando o projeto for FLEX

[6] Obrigatório quando o projeto for FLEX

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

Árvore de páginas

ER_Especificação_S_5012

Informações Gerais

Objetivo

Definição da Regra de Negócio

Protótipo de Tela

Opcional

Fluxo do Processo

Opcional

Dicionário de Dados

(Opcional)

Consulta Padrão

(Opcional)

Estrutura de Menu