Visão Geral do Programa
Lorem Ipsum
Procedimento para Uso
Miscelânea → X→ X
Passo a Passo
Navegação
Ao acessar esta opção será exibido o menu das funcionalidades presentes no FGTS Digital conforme imagem abaixo:
Filtros
Lorem Ipsum
Processamento
Ao aplicarmos os filtros será apresentada a seguinte tela:
Lista de Funcionários
Lorem Ipsum
Ao expandir Lorem Ipsum
Edição da Categoria
Lorem Ipsum:
Download do Arquivo
Lorem Ipsum
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 eu tenha omitido essa informação nos dois 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 |
| Sim |
| dataDesligamentoAte | Data de demissão do funcionário Até |
| Sim |
| 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 | string | cpfTrabalhador | string | dataAdmissao | string | matricula | string | categoriaTSVE | string | pagamentos | array de objeto detalhado abaixo |
Para o array de pagamentos, a estrutura do objeto de retorno no json deve conter obrigatoriamente os campos abaixo.
Campo | Tipo | competencia | string | categoria | string | valorPrincipal | float | valorDecTerceiro | float | indAusenciaFGTS | 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", "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-02", "matricula": "T1D MG 01 24362020210401102019", "categoriaTSVE": "", "pagamentos": [ { "competencia": "02-2021", "categoria": " ", "valorPrincipal": 3000, "valorDecTerceiro": 2000, "indAusenciaFGTS": "" } ] }, { "cnpjEmpregador": "13004999", "cpfTrabalhador": "34702115073", "dataAdmissao": "2020-11-09", "matricula": "T1D MG 01 43810120230518113007", "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" } |
|
|