Foi criada a API para uso dos produtos de produto TOTVS Folha de Pagamento das linhas RM, Datasul e Protheus, que será utilizada na nova tela "Histórico de ProvisãoDados do Dissídio", 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.do Dados do Dissídio (Acordo Coletivo / Reajuste por Lei) que já conhecíamos anteriormente.
Este Este documento contém detalhes técnicos sobre os parâmetros, os retornos de cada um e a funcionalidade da API.
...
| Expandir |
|---|
| title | Inclusão de Registro |
|---|
|
Endpoint: /api/rh/v1/DadosDissidio/
Método: POST
Objetivo: Incluir registros na pagina de Dados do Dissidio
| Expandir |
|---|
| title | Exemplo de requisição |
|---|
| {
"id": "12",
"numeroLei": "21318",
"mesCompPagto": 2,
"anoCompPagto": "2025",
"dtAcordo": "2025-01-01",
"dtEfeito": "2025-12-31",
"tpAcordo": "A",
"descricao": "INCLUSAO DADOS DO DISSIDIO"
} |
| Expandir |
|---|
| 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
}
|
| Expandir |
|---|
| title | Exemplo de utilização |
|---|
| Para análise rápida, importe a seguinte collection no Postman:
| View file |
|---|
| name | DadosDissidio API.postman_collection.json |
|---|
| height | 150 |
|---|
|
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:
| View file |
|---|
| name | mock_dados_do_dissidio_post.json |
|---|
| height | 150 |
|---|
|
|
|
| Expandir |
|---|
|
Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C CHAPADadosDissidio/1%7C13 ( 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: POSTNUMERO DO IDENTIFICADOR )
Método: PUT Objetivo: Alterar um registro já incluido anteriormente
| Expandir |
|---|
| title | Exemplo de requisição |
|---|
| {
"codigoColigadacodColigada": 1,
"id": "13",
"anonumeroLei": 1998"342534",
"mesmesCompPagto": 2,
"chapaanoCompPagto": "000032025",
"dataVencimentoFeriasdtAcordo": "19972024-0801-14T0001T00:00:00-03:00",
"valorPagoFeriasMesdtEfeito": "2025-12-31T00:00:00-03:00",
"tpAcordo": "C",
"tpAcordoTextoTableLayout": "C - Convenção Coletiva de Trabalho",
"descricao": "teste mockoon 123",
"sucessaoVinculo": false
} |
| Expandir |
|---|
| Status Code: 200 OK
{
"codColigada": 1 0,
"valorProvisaoFeriasEmDobro": 15,
"avosFeriasVencidos": 12,
"mediasFeriasVencidas": 200,
"valorProvisaoFeriasVencidas": 0,
"avosFeriasProporcionais": 6,
"mediasFeriasProporcionais": 0,
"valorProvisaoFeriasProporcionaisid": 013,
"valorAbatimentoFeriasnumeroLei": 4400.97,
"valorSemAbatimentoFerias": 4400.97"342534",
"valorProvisaoFerias": 4400.97,
"avos13": 2,
"medias13Salario": 0,
"valorProvisao13": 323.18
} | | Expandir |
|---|
| 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.0mesCompPagto": 2,
"valorProvisaoFeriasProporcionaisanoCompPagto": 0.02025,
"valorAbatimentoFerias":4400.97dtAcordo": "2024-01-01T00:00:00-03:00",
"valorSemAbatimentoFerias":4400.97dtEfeito": "2025-12-31T00:00:00-03:00",
"valorProvisaoFeriastpAcordo": 4400.97"C",
"avos13tpAcordoTextoTableLayout": 2.0"C - Convenção Coletiva de Trabalho",
"medias13Salariodescricao": 0.0"teste mockoon 123",
"valorProvisao13sucessaoVinculo": 323.18false
} |
| Expandir |
|---|
| title | Exemplo de utilização |
|---|
| Para análise rápida, importe a seguinte collection no Postman:
| View file |
|---|
| name | HistoricoProvisaoUpdateDadosDissidio Update.postman_collection.json |
|---|
| height | 150 |
|---|
|
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:
| View file |
|---|
| name | mock_historico_provisao_updateDadosDoDissidio Update.json |
|---|
| height | 150 |
|---|
|
|
|
| Expandir |
|---|
| title | Exclusão de Registro |
|---|
|
Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C CHAPADadosDissidio/1%7C432 ( 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 IDENTIFICADOR )
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
| Expandir |
|---|
| Status Code: 204 No Content
|
| Expandir |
|---|
| title | Exemplo de utilização |
|---|
| Para análise rápida, importe a seguinte collection no Postman:
| View file |
|---|
| name | HistoricoProvisaoDeleteDadosDissidio Delete.postman_collection.json |
|---|
| height | 150 |
|---|
|
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:
| View file |
|---|
| name | mock_historicodados_provisaodissidio_delete.json |
|---|
| height | 150 |
|---|
|
|
|
