Totvs custom tabs box items |
---|
|
Primeiro, devemos adicionar a nova tela ao menu. Como sugestão, posicionar dentro do menu Miscelânea → Fgts, seguindo o passo a passo abaixo para inclusão:
Acessar o Configurador e ir até o menu Ambiente > Cadastros > Menus ![](/download/thumbnails/822676259/image-2024-2-9_17-11-33.png?version=1&modificationDate=1707509493503&api=v2)
Marcar a opção Gestão de Pessoal e clicar em OK
![](/download/attachments/822676259/image-2024-2-9_17-11-49.png?version=1&modificationDate=1707509509280&api=v2)
Clicar em Adicionar
![](/download/attachments/822676259/image-2024-2-9_17-12-7.png?version=1&modificationDate=1707509527533&api=v2)
Selecionar a Opção: Miscelânea > Fgts e clicar em “Novo Item”
![](/download/attachments/822676259/image-2024-2-9_17-12-51.png?version=1&modificationDate=1707509571663&api=v2)
Preencher conforme abaixo
![](/download/attachments/822676259/image-2024-2-9_17-13-30.png?version=1&modificationDate=1707509610927&api=v2)
Clicar em Gerar, preencher com SIGAGPE e clicar em Gerar
![](/download/attachments/822676259/image-2024-2-9_17-14-58.png?version=1&modificationDate=1707509699043&api=v2)
|
Totvs custom tabs box items |
---|
default | yes |
---|
referencia | naveg |
---|
| Navegação e Opções em tela
Ao acessar o novo menu criado, abre-se uma nova tela. Nessa nova tela, será exibido o menu para acesso à tela de Geração de Arquivo de Recomposição de Vínculo Empregatício. ![](/download/thumbnails/822676259/image-2024-3-7_14-53-24.png?version=1&modificationDate=1709834004593&api=v2)
A tela acessada vem, inicialmente, em branco. Sendo necessário selecionar a opção de Filtros Avançados para realizar os filtros necessários na tela. ![](/download/attachments/822676259/image-2024-3-7_14-54-30.png?version=1&modificationDate=1709834070680&api=v2)
Para listar os registros necessários, é necessário preencher os 3 campos obrigatórios (Data Desligamento De, Data Desligamento Até e Filial). ![](/download/attachments/822676259/image-2024-3-7_14-55-16.png?version=1&modificationDate=1709834117093&api=v2)
Pode haver mais de uma filial selecionada, no entanto elas devem ter a mesma raiz de CNPJ obrigatoriamente. Ao aplicarmos os filtros será apresentada a seguinte tela: ![](/download/attachments/822676259/image-2024-3-7_14-55-49.png?version=1&modificationDate=1709834149820&api=v2)
Lista de FuncionáriosAo obter a lista de funcionários, temos as colunas: - CNPJ/CPF Empregador → Correspondente a raiz do CNPJ do empregador;
- CPF trabalhado → Campo RA_CIC;
- Dt. Admissão → Campo RA_ADMISSA;
- Matrícula → Campo RA_CODUNIC;
- Categoria TSVE → Campo RA_CATEFD (mostra apenas quando a categoria é TSVE);
Além disso, temos um botão para expandir os dados de cada um dos funcionários que serão gerados no arquivo. Ao expandir os dados dos funcionários, temos a opção de editar a categoria mencionada abaixo.
Edição da Categoria (Utilizada apenas no Protheus e Datasul)Para o Protheus e Datasul, temos a opção de alterar a categoria do funcionário em determinada competência antes de gerarmos os arquivos. Para realizar essa alteração precisamos acessar o botão de "Alterar Categoria" no detalhamento das informações do funcionário. ![](/download/attachments/822676259/image-2024-3-7_14-57-21.png?version=1&modificationDate=1709834242170&api=v2)
Na alteração da categoria, devemos selecionar a lupa para escolher a nova categoria. ![](/download/attachments/822676259/image-2024-3-7_14-58-10.png?version=1&modificationDate=1709834290860&api=v2)
A opção "Aplicar nas competências anteriores" vem, por padrão, com "Sim". E faz com que as competências anteriores a selecionada desse funcionário também sejam alteradas. Aviso |
---|
| A alteração de categoria não realiza alteração em nenhum local no Protheus e serve apenas para a geração de arquivo de funcionários que tiveram sua categoria alterada ao longo do vínculo empregatício. |
Competências sem incidência de FGTSPodem haver meses sem a incidência de FGTS. Nesse caso, mostraremos os valores zerados e a coluna "Ind. Ausência" como SIM. Por exemplo:
![](/download/attachments/822676259/image-2024-2-19_9-37-32.png?version=1&modificationDate=1708346252947&api=v2)
Download do ArquivoPara fazer o download do arquivo basta selecionar a opção que melhor lhe agrada. ![](/download/attachments/822676259/image-2024-3-7_14-59-22.png?version=1&modificationDate=1709834363690&api=v2)
O arquivo é gerado com base nas informações da tela. O arquivo deve conter no máximo 5000 linhas. Caso ultrapasse esse limite, geramos mais de 1 arquivo, respeitando o limite de 5000 linhas por arquivo. |
Totvs custom tabs box items |
---|
|
Este detalhamento tem como objetivo registrar os endpoints da interface de FGTS Digital, desenvolvida utilizando PO-UI. Para o endpoint principal, adotamos a nomenclatura presente no leiaute oficial fornecido pelo governo, disponível no seguinte link: FGTS Digital - Leiaute do Arquivo de Recomposição Histórico do Vínculo
No PO-UI, é padrão que, ao recebermos uma lista, esta esteja encapsulada dentro de uma propriedade denominada "items". Embora essa informação esteja omitida nos endpoints a seguir, ela pode ser visualizada no JSON de retorno dos exemplos.
Deck of Cards |
---|
| Card |
---|
id | FGTSDigitalLista |
---|
label | FGTS Digital - Lista |
---|
| Objetivo: Busca dos dados para geração do arquivo.
Tipo de requisição: GET Endpoint: /api/rh/v1/fgts-digital Query Params: Nome | Descrição | Tipo | Obrigatório | Exemplo | dataDesligamentoDe | Data de demissão do funcionário De | string | Sim | "2023-01-02T16:37:02-03:00" | dataDesligamentoAte | Data de demissão do funcionário Até | string | Sim | "2024-01-02T16:37:02-03:00" | branch | Filial/Coligada (Multi Valores separados por vírgula) | string | Sim | “D MG 01,D MG 02” | matricula | Matrícula do eSocial | string | Não | “ab123456” |
Estrutura de Retorno: Seguindo a nomenclatura informada no documento do FGTS Digital. Foram definidos os seguintes campos de retorno, sendo todos eles obrigatórios.. Campo | Tipo | cnpjEmpregador (obrigatório) | string | cpfTrabalhador (obrigatório) | string | dataAdmissao (obrigatório) | string | matricula (obrigatório) | string | categoriaTSVE (obrigatório) | string | identFun (novo, opcional) | string | nomeFunc (novo, opcional) | string | pagamentos (obrigatório) | array de objeto detalhado abaixo |
Card documentos |
---|
Informacao | Novas colunas foram adicionadas (identFun e nomeFunc) acesse a documentação em Assuntos Relacionados. |
---|
Titulo | Importante |
---|
|
Para o array de pagamentos, Para o array de pagamentos, a estrutura do objeto de retorno no json deve conter obrigatoriamente os campos abaixo. Campo | Tipo | competenciacompetencia | string | categoria | string | valorPrincipal | float | valorDecTerceirovalorDecTerceiro | float | indAusenciaFGTSindAusenciaFGTS | string |
Exemplo de Requisição: GET /api/rh/v1/fgts-digital?branchCode=D MG 02&dataDesligamentoDe=&dataDesligamentoAte= Expandir |
---|
| { "items": [ { "cnpjEmpregador": "13004999", "cpfTrabalhador": "22603302078", "dataAdmissao": "2021-01-02", "matricula": "T1D MG 01 24361020210401101518", "identFun": "T1D MG 01 243610", "nomeFun": "JOAO BATISTA DA SILVA", "categoriaTSVE": "", "pagamentos": [ { "competencia": "10-2021", "categoria": " ", "valorPrincipal": 2000, "valorDecTerceiro": 0, "indAusenciaFGTS": "" }, { "competencia": "11-2021", "categoria": " ", "valorPrincipal": 0, "valorDecTerceiro": 0, "indAusenciaFGTS": "S" }, { "competencia": "12-2021", "categoria": " ", "valorPrincipal": 2000, "valorDecTerceiro": 2000, "indAusenciaFGTS": "" }, ] }, { "cnpjEmpregador": "13004999", "cpfTrabalhador": "38372084009", "dataAdmissao": "2021-01-0202", "matricula": "T1D MG 01 24362020210401102019", "identFun": "T1D MG 01 243620", "matriculanomeFun": "T1D MG 01 24362020210401102019MARIANA OLIVEIRA", "categoriaTSVE": "", "pagamentos": [ { "competencia": "02-2021", "categoria": " ", "valorPrincipal": 3000, "valorDecTerceiro": 2000, "indAusenciaFGTS": "" } ] }, { "cnpjEmpregador": "13004999", "cpfTrabalhador": "34702115073", "dataAdmissao": "2020-11-09", "matricula": "T1D MG 01 43810120230518113007", "identFun": "T1D MG 01 438101", "nomeFun": "RAFAEL DOS REIS", "categoriaTSVE": "", "pagamentos": [ { "competencia": "02-2021", "categoria": "101", "valorPrincipal": 3500, "valorDecTerceiro": 0, "indAusenciaFGTS": "" }, { "competencia": "03-2021", "categoria": "101", "valorPrincipal": 3500, "valorDecTerceiro": 0, "indAusenciaFGTS": "" } ] } ] } |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
Expandir |
---|
| { "code": 500, "detailedMessage": "", "message": "Internal Server Error", "type": "error" } |
|
Card |
---|
id | FGTSDigitalBranches |
---|
label | FGTS Digital - Branches |
---|
| Objetivo: Listagem de Filiais (Protheus) / Coligadas (RM) / Estabelecimento (Datasul)
Tipo de requisição: GET Endpoint: /api/rh/v1/fgts-digital/branches Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | filter | Campo automático do lookup. Pode filtrar o código ou nome da filial/coligada | string | Não | “Filial X” |
Estrutura de Retorno: Para conseguirmos abranger todas as áreas, utilizamos a nomenclatura abaixo. Campo | Tipo | branchCode | string | branchName | string |
Exemplo de Requisição: GET /api/rh/v1/fgts-digital/branches?filter=D MG Expandir |
---|
| { "items": [ { "branchCode": "D MG 01", "branchName": "Filial BELO HOR" }, { "branchCode": "D MG 02", "branchName": "Filial UBERABA" } ] } |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
Expandir |
---|
| { "code": 500, "detailedMessage": "", "message": "Internal Server Error", "type": "error" } |
|
Card |
---|
id | FGTSDigitalCategorias |
---|
label | FGTS Digital - Categorias |
---|
| Objetivo: Para o Protheus, foi disponibilizada a opção de trocar a categoria de determinado registro antes de realizar a geração do arquivo. Para isso, foi necessário necessária a criação de um endpoint de Listagem de Categorias. Tipo de requisição: GET Endpoint: /api/rh/v1/fgts-digital/categorias Query Params: Campo | Descrição | Tipo | Obrigatório | Exemplo | branchCode | Campo com a filial que será realizada a busca das categorias | string | Sim | "D MG 01" | filter | Campo automático do lookup. Pode filtrar o código ou descrição da categoria | string | Não | “Empregado” |
Estrutura de Retorno: Para o retorno, utilizamos a forma abaixo. Campo | Tipo | codigo | string | descricao | string |
Exemplo de Requisição: GET /api/rh/v1/fgts-digital/categorias?branchCode=D MG 01&filter=Empregado Expandir |
---|
| { "items": [ { "codigo": "101", "descricao": "Empregado - Geral, inclusive o empregado público da administração direta ou indireta contratado pela CLT" }, { "codigo": "102", "descricao": "Empregado - Trabalhador rural por pequeno prazo da Lei 11.718/2008" }, { "codigo": "103", "descricao": "Empregado - Aprendiz" }, { "codigo": "104", "descricao": "Empregado - Doméstico" }, { "codigo": "105", "descricao": "Empregado - Contrato a termo firmado nos termos da Lei 9.601/1998" }, { "codigo": "107", "descricao": "Empregado - Contrato de trabalho Verde e Amarelo - sem acordo para antecipação mensal da multa rescisória do FGTS" }, { "codigo": "108", "descricao": "Empregado - Contrato de trabalho Verde e Amarelo - com acordo para antecipação mensal da multa rescisória do FGTS" }, { "codigo": "111", "descricao": "Empregado - Contrato de trabalho intermitente" }, { "codigo": "721", "descricao": "Contribuinte individual - Diretor não empregado, com FGTS" }, { "codigo": "722", "descricao": "Contribuinte individual - Diretor não empregado, sem FGTS" } ] } |
Para o retorno de erro, seguir a estrutura abaixo. Campo | Tipo | code | number | message | string | detailedMessage | string | type | string (“error”, “warning”, “success”) |
Expandir |
---|
| { "code": 500, "detailedMessage": "", "message": "Internal Server Error", "type": "error" } |
|
|
|
|