Histórico da Página
Dados Gerais | |
---|---|
Módulo: | TOTVS Automação Fiscal (SIGATAF) |
Issue: | DSERTAF1-35402 |
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.
Campos normalmente utilizados pelo TAF e campos para gravar xml e json para view do evento:
Nome do campo | Descrição do campo |
---|---|
VXX_FILIAL | Filial do registro |
VXX_ID | Id do registro na tabela |
VXX_VERSAO | Versão do registro na tabela |
VXX_PERAPU | Periodo do registro |
VXX_ATIVO | Status do registro |
VXX_EVENTO | TIpo do evento |
VXX_STATUS | Status de transmissão |
VXX_XMLID | XML id do registro |
VXX_LAYOUT | Versão do layout no eSocial |
VXX_VIEW | Json para api Registros S-5503 | Listagem |
VXX_MATCAT | Json para api Trabalhador do S-5503 | Informações Relativas a Matrícula e Categoria |
VXX_STABPAG | Json para api-Trabalhador do S-5503 | Identificação do estabelecimento responsável pelo pagamento dos valores informados |
XMLGRV | Xml que será gravado no momento do retorno do totalizador |
Registros S-5503 | Listagem
00010434-view
VXX_VIEW :
{
"hasNext": false,
"items": [
{
"id": "00010434",
"period": "2023-08",
"cpf": "82977978054",
"name": "Alex André",
"receipt": "1.2.0000000000195474657",
"processNumber": "00010434"
},
{
"id": "00010435",
"period": "2023-08",
"cpf": "11117075028",
"name": "Fabio men",
"receipt": "1.2.0000000000195474658",
"processNumber": "00010435"
}
]
}
Trabalhador do S-5503 | Informações Relativas a Matrícula e Categoria
VXX_MATCAT :
00010434-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
VXX_STABPAG:
00010434-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 :
1 - Grvação dos campos pela função padrão GRV.
- Para a gravação ser efetuada com sucesso eventos predecessores deverão ser validados, no caso dos totalizadores sempre tem gravação aberta.
- Desenvolvimento do json para view.
- Não irá precisar fazer persistencia de campos em modelo relacional.
- As informaçãoes como nome ou descrição de informações que irão no json serão capturadas neste momento.
- Para a busca das imformações é sugerido que se tenha novas funções pensando em diminuir a oneração na performance, o exemplo mais comum seria a pesquisa por lotação.
- A intenção é não utilizarmos a função FGetIdInt pois já é comprovado na refatoração dos fontes tafa421 que onera a performance na integração
2 - Geração do XML E JSON será na mesma função com valores já gravados pela GRV.
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. Listagem das api ´
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:
https://api.totvs.com.br/apidetails/FGTSPerWorkerInLaborProcess_v1_000.json