Histórico da Página
Dados Gerais | |
---|---|
Módulo: | TOTVS Automação Fiscal (SIGATAF) |
Issue: | DSERTAF1-35311 |
Descrição: | Criação do evento S-5503 |
Data | 03/07/2024 |
Analistas | Alexandre de Lima Santos |
Descrição Funcional
- Modelo de gravação de dados.
- Com base nas funcionalidades especificas no front, listagem de todas as APIs necessárias.
01. Tabela Modelo
A tabela modelo irá seguir o padrão TAF de desenvolvimento assim como é hoje, a diferença se da em 4 campos que irão gravar parte do json e xml do totalizador integrado, o modelo abaixo é uma representação dos valores que irão ser gravados em seus respectivos campos assim como as api´s referentes a cada funcionalidade no front.
...
Nome do campo | Descrição do campo |
---|---|
VXXT8N_FILIAL | Filial do registro |
VXXT8N_ID | Id do registro na tabela |
VXXT8N_VERSAO | Versão do registro na tabela |
VXXT8N_PERAPU | Periodo do registro |
VXXT8N_ATIVO | Status do registro |
VXXT8N_EVENTO | TIpo do evento (NÃO NECESSARIO) |
VXXT8N_STATUS | Status de transmissão (NÃO NECESSARIO) |
VXXT8N_XMLID | XML id do registro (NÃO NECESSARIO) |
VXXT8N_LAYOUT | Versão do layout no eSocial |
VXXT8N_XMLGRV | Xml que será gravado no momento do retorno do totalizador. |
VXXT8N_VIEW | Json para api Registros S-5503 | Listagem. |
VXXT8N_MATCAT | Json para api Trabalhador do S-5503 | Informações Relativas a Matrícula e Categoria. |
VXXT8N_STABPAG STABPA | Json para api-Trabalhador do S-5503 | Identificação do estabelecimento responsável pelo pagamento dos valores informados. |
Registros S-5503 | Listagem
Ao realizar a requisição para montar a tela de view e as demais telas será passado o id + tag relativa ao campo a ser pesquisado e retornar o json para a view, caso nossa requisição seja para a tela inicial será enviado Id+ Campo, exmplo 00010434_VIEW no caso teremos 00010434 como recno do registro e _VIEW o campo que iremos buscar os valores.
VXX→VXX_VIEW :
...
Campo - VXX_XMLGRV
Campo | Json gerado na integração. |
---|---|
VXX_XMLGRV | <eSocial xmlns="http://www.esocial.gov.br/schema/evt/evtFGTSProcTrab/v_S_01_02_00"> |
...
<infoFGTSProcTrab> |
...
<totalFGTS>0</totalFGTS> |
...
</infoFGTSProcTrab> |
Registros S-5503 | Listagem
Campo | Json gerado na integração. |
---|---|
VXX→VXX_VIEW | { |
...
00010434", |
...
82977978054", |
...
Alex André", |
...
0000000000195474657", |
...
00010434" |
...
] |
Trabalhador do S-5503 | Informações Relativas a Matrícula e Categoria
VXX_MATCAT - O conceito de id + tag relativa ao campo a ser pesquisado irá retornar o json para a view.
00010434_MATCAT
Recno = 00010434
Campo = _MATCAT
Campo | Json gerado na integração. |
---|---|
VXX→VXX_MATCAT |
...
{ "hasNext": false, "items": [ { "id": "00010434", "registration": "MAT_42227624078", "category": "101", "fgtsTot": "27000.15" } ] } |
Trabalhador do S-5503 | Identificação do estabelecimento responsável pelo pagamento dos valores informados
...
Campo | Json gerado na integração. |
---|
VXX_STABPAG - O conceito de id + tag relativa ao campo a ser pesquisado irá retornar o json para a view.
00010434_STABPAG
Recno = 00010434
...
VXX→VXX_STABPAG |
...
"hasNext": false, "items": [ { "id": "00010434", "referencePeriod": "2023-12", "category": "101", "typeOfLaborProcessValue": "71", "remFGTSProcTrab": "59000.99", "remFGTSSefip": "845.00", "dpsFGTSSefip": "23500.45", "remFGTSDecAnt": "5015.19", "dpsFGTSDecAnt": "23055.45" } ] |
Gravação e geração do modelo :
...
3 - Criar uma função que reavalie o xml do front para gerar novo Json de view caso ocorra erro no momento da integração que leve dados incorretos a tela ( Hoje temos o reavaliar totalizadores).
02. Chamada da View
Ao realizar a requisição para montar a tela de view e as demais telas será passado o id + tag relativa ao campo a ser pesquisado e retornar o json para a view, caso nossa requisição seja para a tela inicial será enviado Id+ Campo, exmplo 00010434_VIEW no caso teremos 00010434 como recno do registro e _VIEW o campo que iremos buscar os valores.
recno + tag | Campo | Retorno |
---|---|---|
00010434_VIEW | VXX_VIEW | Json |
00010434_MATCAT | VXX_MATCAT | Json |
00010434_STABPAG | VXX_STABPAG | Json |
03. Listagem das api ´s
1- Registros S-5503 | Listagem
Carrega registros do evento S-5503, filtrados ou não, ordenados ou não.
2- Registros S-5503 | Exclusão
Exclui eventos S-5503 conforme coleção de ID's informados.
3- Registros S-5503 | XML
Retorna XML's do evento S-5503 encodados em base64.
4- Trabalhador do S-5503 | Informações Relativas a Matrícula e Categoria
Carrega informações relativas a Matrícula e Categoria de trabalhador específico do evento S-5503, ordenadas ou não.
5- Trabalhador do S-5503 | Identificação do estabelecimento responsável pelo pagamento dos valores informados
Carrega informações relativas a Identificação do estabelecimento responsável pelo pagamento a trabalhador específico dos valores informados do evento S-5503, ordenadas ou não.
04. Links de consulta:
...