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ços | ||
Projeto | DSERTAF1 - Desenvolvimento TAF eSocial | IRM/EPIC | |
Issue | DSERTAF1-9279 | Subtarefa | |
Ticket | 3822483 | ||
País | ( x ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros |
Objetivo
Disponibilizar para o cliente uma rotina que consulte o sistema eSocial BX do governo para obter o número do recibo e atualizar a base do TAF que não possuam essa informação.
Definição da Regra de Negócio
Conforme o Manual de Orientação do Desenvolvedor versão Versão 1.7 Agosto de 2018, o sistema eSocial disponibiliza o WEBSERVICE DE CONSULTA AOS IDENTIFICADORES DOS EVENTOS.
A função deste Webservice é possibilitar ao sistema do empregador consultar os identificadores dos eventos para os quais o eSocial emitiu recibo. Este serviço retorna além dos identificadores, o número do recibo.
Será criada a rotina Consulta Recibo eSocial BX (TAFA519), que possibilitará ao cliente, por meio de consulta ao sistema do governo, atualizar a base do TAF, preenchendo o número do recibo dos registros que estão sem.
Rotina | Tipo de Operação | Opção de Menu |
TAFA519 - Consulta Recibo eSocial BX | Criação | Miscelânea →Funcionalidades |
WSSOCIAL | Alteração | Não se aplica |
No acesso a rotina, será apresentada a tela principal (Protótipo Tela Principal), onde serão apresentados os painéis:
- Parâmetros: Apresenta os campos necessários para consulta ao eSocial BX.
O painel possuirá os seguintes campos:- Tipo de Evento: Tipo do evento disponível para consulta (Tabela ou Trabalhador).
- Evento: Código do evento, quando selecionado o tipo de evento Tabela.
- Data de: Data inicial referente ao intervalo de dados que se deseja consultar no sistema eSocial BX. Este campo será preenchido quando informado o tipo de evento Tabela ou Trabalhador.
- Data até: Data final referente ao intervalo de dados que se deseja consultar no sistema eSocial BX. Este campo será preenchido quando informado o tipo de evento Tabela ou Trabalhador.
- Hora de: Hora inicial referente ao intervalo de dados que se deseja consultar no sistema eSocial BX. Este campo será preenchido quando informado o tipo de evento Tabela ou Trabalhador.
- Hora até: Hora final referente ao intervalo de dados que se deseja consultar no sistema eSocial BX. Este campo será preenchido quando informado o tipo de evento Tabela ou Trabalhador.
- Ano/Mês: Ano e mês a ser consultado no sistema eSocial BX. (Não utilizado para consulta do tipo de evento Tabela ou Trabalhador).
- CPF do trabalhador: Número do CPF do trabalhador no qual se deseja consultar registros no sistema eSocial BX. Este campo será preenchido quando informar o tipo de evento Trabalhador.
- Chave Evento: Chave identificadora para consulta de registros quando o tipo de evento for igual a Tabela.
- Registros: Apresenta os registros da base do TAF que não possuem recibo, conforme dados retornados pelo eSocial BX.
O painel apresentará as seguintes colunas:- Filial: Filial do registro.
- Recibo: Número do recibo obtido por meio do eSocial BX.
- Evento: Código do evento.
- Status: Indica se o registro está ativo ou inativo.
- Parâmetros: Apresenta os campos necessários para consulta ao eSocial BX.
- Contadores: Apresenta alguns contadores para auxilio no processo de consultas.
O painel apresentará os seguintes campos:
- Consultas Restantes: Indica quantas consultas o cliente pode realizar no dia, conforme sinalizado pelo governo, será possível fazer 10 consultas por dia.
- Registros Processados: Mostra quantos registros foram retornados durante a consulta em andamento, com o intuito do cliente saber se está chegando próximo do máximo localizado pelo governo.
- Registros Disponíveis: Apresenta a quantidade máxima de registros encontrados pelo governos, conforme o filtro realizado no painel Parâmetros.
Serão disponibilizados os seguintes botões:
- Consultar Governo:
Botão apresentado no painel Parâmetros, aciona o TSS para realização da consulta no eSocial BX, utilizando os dados informados no painel Parâmetros. Após a consulta, será avaliado os dados retornados pelo governo e os registros do TAF sem número de recibo serão apresentados no painel Registros, com o número de recibo retornado pelo eSocial BX. - Confirmar:
Botão para realizar a gravação dos recibos nos registros carregados no painel Registros. - Visualizar Registro:
Botão apresentado em Outras Ações, apresenta nova tela com os detalhes do registro selecionado no painel Registros.
- Log de Consulta:
Botão apresentado em Outras Ações, apresenta tela (protótipo Tela Log) com o log das consultas realizadas no eSocial BX. Possuirá as seguintes colunas:
- Consultar Governo:
- Data: Data em que a consulta foi realizada.
- Hora: Hora em que a consulta foi realizada
- Tipo Evento: Tipo de evento consultado (Empregador, Tabela ou Trabalhador).
- Evento: Evento consultado, caso o tipo de evento seja igual a tabela.
- Usuário: Apres.
- Código Retorno: Código de retorno do governo, que indica se houve sucesso ou detalha a falha.
- Descrição Retorno: Descrição do código de retorno, também retornado pelo governo
- Consulta Base TAF:
Botão apresentado em Outras Ações, apresenta tela (protótipo Tela Base TAF) com os registros transmitidos para o governo que não possuem registros com base nos parâmetros definido no painel Parâmetros:
Essa consulta tem como intuito apresentar os registros existentes no TAF que atendem os parâmetros definidos pelo cliente no painel Parâmetros, com essa informação, o cliente poderá refinar os parâmetros otimizando o retorno do governo. A consulta será integrada ao TSS, devido a necessidade de avaliar a data e hora da transmissão para o governo. Serão apresentadas as seguintes colunas:
- Consulta Base TAF:
- Evento: Código do evento.
- Data: Data de transmissão para o Governo.
- Hora: Hora de transmissão para o Governo.
Restrições estipuladas pelo Governo:
- As consultas não poderão ser realizadas entre os dias 1 a 7 de cada mês.;
- Cada empregador só poderá realizar uma consulta por vez, ou seja, não será permitido paralelismo;
- Cada empregador poderá realizar no máximo 10 acessos por dia aos Webservices;
- A consulta deverá ser realizada com data limite até uma hora a menos que a data atual;
- Os retornos das consultas conterão os eventos recebidos até uma hora a menos que a data atual;
- Na consulta, serão retornados até 50 registros, ordenados por data de envio. Para obter os demais registros que atendam os parâmetros de busca, deve ser realizada nova busca ajustando a data inicial da consulta, consumindo assim o limite diário do webservice.
Tabelas Utilizadas
C1E – Compl. Estabelecimento
C1G - Processos Referenciados
C8R - Rubricas
C8V - Cargos
C8W - Operadores Portuários
C8X - Funções
C90 - Horários/Turnos de Trabalho
C91 - Folha de Pagamento
C92 - Tabela de Estabelecimentos
C99 - Tabela de Lotações
C9V - Dados do Trabalhador
CMD - Desligamento
CMR - Aquisição de Produção Rural
CUO - Fechamento
CUP - Cadastro Inicial do Vínculo
T04 - Ambientes de Trabalho
T0G - Informações relativas IRRF
T1M - Comer. Prod. Rural PF
T1S - Reabertura Eventos Periódicos
T2A - Contrat. Trab. Avulsos
T2G - Imp. de Renda Retido na Fonte
T2M - Contrib. Social Trab.
T2V - Inf Relat Contrib Sociais
T3P - Pgto Rendimentos do Trabalho
T3V - Informações de Subst. Patronal
T3Z -Info de Apur da Cont Sindical
T5K - Tabela de Carreiras Públicas
T72 - Solic Total Pagto Contingência
T92 -Trabalhador Sem Vínculo de Emp
- V2N - Log eSocial BX
Protótipo de Tela
Protótipo Tela Principal
Protótipo Tela Log
Protótipo Tela Base TAF
Dicionário de Dados
Arquivo:V2N– Log eSocial BX
Tabela
Chave | Nome | Modo | Pyme |
V2N | Log eSocial BX | Exclusivo | Sim |
Campos
Campo | V2N_FILIAL |
Tipo | Caracter |
Tamanho | 8 |
Decimal | 0 |
Título | Filial |
Descrição | Filial do Sistema |
Usado | Não |
Obrigatório | Não |
Browse | Não |
Grupo de Campos | 033 - Tamanho da Filial |
Ordem | 01 |
Campo | V2N_ID |
Tipo | Caracter |
Tamanho | 36 |
Decimal | 0 |
Título | ID |
Descrição | ID |
Usado | Sim |
Obrigatório | Não |
Browse | Não |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 02 |
Campo | V2N_DATA |
Tipo | Data |
Tamanho | 8 |
Decimal | 0 |
Título | Data Cons |
Descrição | Data da consulta |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Inic. Padrão | dDataBase |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 03 |
Campo | V2N_HORA |
Tipo | Caracter |
Tamanho | 6 |
Decimal | 0 |
Formato | @R 99:99:99 |
Título | Hora Cons. |
Descrição | Hora da consulta |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Inic. Padrão | Time() |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 04 |
Campo | V2N_TIPOEV |
Tipo | Caracter |
Tamanho | 1 |
Decimal | 0 |
Formato | @! |
Título | Tipo Evento |
Descrição | Tipo do evento |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Opções | 1=Empregador; 2=Tabela; 3=Trabalhador |
Val. Sistema | Vazio() .OR. Pertence("1|2|3") |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 05 |
Campo | V2N_EVENTO |
Tipo | Caracter |
Tamanho | 6 |
Decimal | 0 |
Formato | @! |
Título | Evento |
Descrição | Evento consultado |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 06 |
Campo | V2N_CODUSR |
Tipo | Caracter |
Tamanho | 6 |
Decimal | 0 |
Formato | @! |
Título | Cod. Usuário |
Descrição | Código do usuário |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Inic. Padrão | RETCODUSR() |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 07 |
Campo | V2N_NOMUSR |
Tipo | Caracter |
Tamanho | 30 |
Decimal | 0 |
Formato | @! |
Título | Nome Usuário |
Descrição | Nome do usuário |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Inic. Padrão | USRRETNAME(V2N->V2N_CODUSR) |
Contexto | Virtual |
Propriedade | Visualizar |
Inic. Browse | USRRETNAME(V2N->V2N_CODUSR) |
Ordem | 08 |
Campo | V2N_CODRET |
Tipo | Caracter |
Tamanho | 3 |
Decimal | 0 |
Título | Cod. Ret. |
Descrição | Código Retornado |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 09 |
Campo | V2N_DSCRET |
Tipo | Caracter |
Tamanho | 250 |
Decimal | 0 |
Formato | @! |
Título | Desc Ret. |
Descrição | Descrição do retorno |
Usado | Sim |
Obrigatório | Não |
Browse | Sim |
Contexto | Real |
Propriedade | Visualizar |
Ordem | 10 |
Índices
Índice | V2N |
Ordem | 1 |
Chave | V2N_FILIAL + DTOS(V2N_DATA) + V2N_HORA |
Descrição | Data Cons + Hora Cons. |
Mostra Pesq. | Sim |
Consulta Padrão
Consulta: C9VE
Descrição | CPF Trabalhador |
Tipo | Consulta Padrão |
Tabela | C9V |
Índice | ID |
Campo | “Filial”; ”ID”; ”Nome”; ”CPF” |
Retorno | C9V_CPF |
Consulta: TAFCHV
Descrição | Chave Evento Tabela |
Tipo | Consulta Especifica |
Expressão | TAFSXBChv() |
Retorno | VAR_IXB |
Consulta: TAFETB
Descrição | Eventos de Tabela |
Tipo | Consulta Especifica |
Expressão | TAFSXBETab() |
Retorno | VAR_IXB |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|