Foi criada a API para uso dos produtos de Folha de Pagamento das linhas RM, Datasul e Protheus, que será utilizada na nova tela "Histórico de Provisão", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Histórico de Provisões que já conhecíamos anteriormente.
Este módulo contém dados relativos às provisões mensais de Férias e 13º salário.

Este documento contém detalhes técnicos sobre os parâmetros, os retornos de cada um e a funcionalidade da API.


Informações Técnicas das API's utilizadas 

Endpoint:  /api/rh/v1/DadosDissidio/Schema
Método:
GET
Objetivo: 
Retornar o Schema utilizado neste endpoint, com propriedades e tipos de dados

{
    "title": "Dados Dissidio",
    "version": "1.0",
    "identifier": "DadosDissidio",
    "fields": [
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "codColigada",
            "label": "Coligada",
            "disabled": true,
            "visible": false,
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "required": true,
            "mask": "9999",
            "maskFormatModel": true,
            "maxLength": 4,
            "layoutDefinition": [
                {
                    "gridColumns": 2,
                    "componentType": "EditLayout"
                }
            ],
            "key": true,
            "property": "id",
            "label": "Identificador",
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "maxLength": 12,
            "layoutDefinition": [
                {
                    "gridColumns": 4,
                    "componentType": "EditLayout"
                }
            ],
            "property": "numeroLei",
            "label": "Número da Lei do reajuste retroativo",
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "options": [
                {
                    "value": 1,
                    "label": "Janeiro"
                },
                {
                    "value": 2,
                    "label": "Fevereiro"
                },
                {
                    "value": 3,
                    "label": "Março"
                },
                {
                    "value": 4,
                    "label": "Abril"
                },
                {
                    "value": 5,
                    "label": "Maio"
                },
                {
                    "value": 6,
                    "label": "Junho"
                },
                {
                    "value": 7,
                    "label": "Julho"
                },
                {
                    "value": 8,
                    "label": "Agosto"
                },
                {
                    "value": 9,
                    "label": "Setembro"
                },
                {
                    "value": 10,
                    "label": "Outubro"
                },
                {
                    "value": 11,
                    "label": "Novembro"
                },
                {
                    "value": 12,
                    "label": "Dezembro"
                }
            ],
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "TableLayout"
                }
            ],
            "forceOptionsComponentType": "select",
            "property": "mesCompPagto",
            "label": "Mês Pagamento",
            "componentType": "Select"
        },
        {
            "quickFilter": true,
            "mask": "9999",
            "maskFormatModel": true,
            "maxLength": 4,
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "TableLayout"
                }
            ],
            "property": "anoCompPagto",
            "label": "Ano Pagamento",
            "type": "string",
            "componentType": "Input"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                }
            ],
            "property": "dtAcordo",
            "label": "Data da assinatura do acordo",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                }
            ],
            "property": "dtEfeito",
            "label": "Data do efeito",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "quickFilter": true,
            "required": true,
            "options": [
                {
                    "value": "A",
                    "label": "A - Acordo Coletivo de Trabalho"
                },
                {
                    "value": "B",
                    "label": "B - Legislação federal, estadual, municipal ou distrital"
                },
                {
                    "value": "C",
                    "label": "C - Convenção Coletiva de Trabalho"
                },
                {
                    "value": "D",
                    "label": "D - Sentença Normativa - Dissídio"
                },
                {
                    "value": "E",
                    "label": "E - Conversão de Licença Saúde em Acidente de Trabalho"
                },
                {
                    "value": "F",
                    "label": "F - Outras verbas de natureza salarial ou não salarial devidas após o desligamento"
                },
                {
                    "value": "G",
                    "label": "G - Antecipação de diferenças de Acordo, Convenção ou Dissídio Coletivo"
                },
                {
                    "value": "I",
                    "label": "I - Sentença judicial (exceto reclamatória trabalhista)"
                },
                {
                    "value": "J",
                    "label": "J - Parcelas complementares conhecidas após o fechamento da folha"
                }
            ],
            "layoutDefinition": [
                {
                    "gridColumns": 6,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "TableLayout"
                }
            ],
            "forceOptionsComponentType": "select",
            "property": "tpAcordo",
            "label": "Tipo do acordo",
            "componentType": "Select"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "AdvancedFilterLayout"
                },
                {
                    "visible": false,
                    "componentType": "FilterLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "tpAcordoTextoTableLayout",
            "label": "Tipo do Acordo",
            "type": "string",
            "componentType": "Input"
        },
        {
            "required": true,
            "maxLength": 255,
            "rows": 3,
            "layoutDefinition": [
                {
                    "gridColumns": 12,
                    "componentType": "EditLayout"
                }
            ],
            "property": "descricao",
            "label": "Descrição",
            "componentType": "TextArea"
        },
        {
            "booleanTrue": "Sim",
            "booleanFalse": "Não",
            "layoutDefinition": [
                {
                    "gridColumns": 12,
                    "componentType": "EditLayout"
                }
            ],
            "property": "sucessaoVinculo",
            "label": "Pagamento de verbas devidas pela empresa sucessora a empregados desligados ainda na sucedida",
            "type": "boolean",
            "componentType": "Switch"
        }
    ],
    "groups": []
}

Endpoint:  /api/rh/v1/DadosDissidio/
Método:
POST
Objetivo: 
Incluir registros na pagina de Dados do Dissidio

{
  "id": "12",
  "numeroLei": "21318",
  "mesCompPagto": 2,
  "anoCompPagto": "2025",
  "dtAcordo": "2025-01-01",
  "dtEfeito": "2025-12-31",
  "tpAcordo": "A",
  "descricao": "INCLUSAO DADOS DO DISSIDIO"
}

Status Code: 201 Created

{
    "codColigada": 1,
    "id": 12,
    "numeroLei": "21318",
    "mesCompPagto": 2,
    "anoCompPagto": 2025,
    "dtAcordo": "2025-01-01T00:00:00-03:00",
    "dtEfeito": "2025-12-31T00:00:00-03:00",
    "tpAcordo": "A",
    "descricao": "INCLUSAO DADOS DO DISSIDIO",
    "sucessaoVinculo": false
}

Para análise rápida, importe a seguinte collection no Postman:



Para a utilização da collection, podemos utilizar um mock, para melhor visualização da API, basta importar o seguinte arquivo .json, usando a ferramenta Mockoon, basta importar o enviroment na ferramenta e iniciar o servidor:



Endpoint:   /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C  CHAPA ( Este end point é dinâmico, onde o que se mantém sempre é %7C e o que sempre se altera são as informações CODCOLIGADA / ANOCOMP / MESCOMP / CHAPA   )

Exemplo de requisição com Endpoint montado:

/api/rh/v1/HistoricoProvisao/1%7C1998%7C2%7C00004

Método:  POST

Objetivo: Alterar um registro já incluido anteriormente

{
    "codigoColigada": 1,
    "ano": 1998,
    "mes": 2,
    "chapa": "00003",
    "dataVencimentoFerias": "1997-08-14T00:00:00-03:00",
    "valorPagoFeriasMes": 0,
    "valorProvisaoFeriasEmDobro": 15,
    "avosFeriasVencidos": 12,
    "mediasFeriasVencidas": 200,
    "valorProvisaoFeriasVencidas": 0,
    "avosFeriasProporcionais": 6,
    "mediasFeriasProporcionais": 0,
    "valorProvisaoFeriasProporcionais": 0,
    "valorAbatimentoFerias": 4400.97,
    "valorSemAbatimentoFerias": 4400.97,
    "valorProvisaoFerias": 4400.97,
    "avos13": 2,
    "medias13Salario": 0,
    "valorProvisao13": 323.18
}


Status Code: 200  OK

{
    "codigoColigada": 1,
    "ano": 1998,
    "mes": 2,
    "chapa": "00003",
    "dataVencimentoFerias": "1997-08-14T00:00:00-03:00",
    "valorPagoFeriasMes": 0.0,
    "valorProvisaoFeriasEmDobro": 15.0,
    "avosFeriasVencidos": 12.0,
    "mediasFeriasVencidas": 200.0,
    "valorProvisaoFeriasVencidas": 0.0,
    "avosFeriasProporcionais": 6.0,
    "mediasFeriasProporcionais": 0.0,
    "valorProvisaoFeriasProporcionais": 0.0,
    "valorAbatimentoFerias": 4400.97,
    "valorSemAbatimentoFerias": 4400.97,
    "valorProvisaoFerias": 4400.97,
    "avos13": 2.0,
    "medias13Salario": 0.0,
    "valorProvisao13": 323.18
}

Para análise rápida, importe a seguinte collection no Postman:



Para a utilização da collection, podemos utilizar um mock, para melhor visualização da API, basta importar o seguinte arquivo .json, usando a ferramenta Mockoon, basta importar o enviroment na ferramenta e iniciar o servidor:



Endpoint:   /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C  CHAPA ( Este end point é dinâmico, onde o que se mantém sempre é %7C e o que sempre se altera são as informações CODCOLIGADA / ANOCOMP / MESCOMP / CHAPA   )

Exemplo de requisição com Endpoint montado:

/api/rh/v1/HistoricoProvisao/1%7C1998%7C2%7C00004

Método:  DELETE

Objetivo: Excluir um registro já incluido anteriormente

Status Code: 204  No Content

Para análise rápida, importe a seguinte collection no Postman:



Para a utilização da collection, podemos utilizar um mock, para melhor visualização da API, basta importar o seguinte arquivo .json, usando a ferramenta Mockoon, basta importar o enviroment na ferramenta e iniciar o servidor: