Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 38

changes.mady.by.user Isabel Noguti

Gravado em

comparado com

Nova versão 39

changes.mady.by.user Isabel Noguti

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

05. ASSUNTOS RELACIONADOS

        Não se aplica

Informações Técnicas da API

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.

...

idFGTSDigital

...

idFGTSDigitalLista
labelFGTS 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

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
titleExemplo de retorno

{
    "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
titleExemplo de retorno

{
    "code": 500,
    "detailedMessage": "",
    "message": "Internal Server Error",
    "type": "error"
}

...

idFGTSDigitalBranches
labelFGTS 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
titleExemplo de retorno

{
    "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
titleExemplo de retorno

{
    "code": 500,
    "detailedMessage": "",
    "message": "Internal Server Error",
    "type": "error"
}

...

idFGTSDigitalCategorias
labelFGTS 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 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
titleExemplo de retorno

{
    "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
titleExemplo de retorno

{
    "code": 500,
    "detailedMessage": "",
    "message": "Internal Server Error",
    "type": "error"
}