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ão", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Histórico de Provisões que já conheciamos conhecíamos anteriormente.
Este módulo contém dados relativos às provisões mensais de Férias e 13º salário.
...
| Expandir |
|---|
| title | Inclusão de Registro |
|---|
|
Endpoint: /api/rh/v1/HistoricoProvisao/
Método: POST
Objetivo: Incluir registros no Histórico da provisão de maneira manual, não necessitando do processo de geração de historico de provisão.
| Expandir |
|---|
| title | Exemplo de requisição |
|---|
| {
"codigoColigada": 1,
"ano": 2024,
"mes": 7,
"chapa": "F0002",
"dataVencimentoFerias": "2025-02-01T00:00:00-03:00",
"valorPagoFeriasMes": 0,
"valorProvisaoFeriasEmDobro": 210.46,
"avosFeriasVencidos": 24,
"mediasFeriasVencidas": 150,
"valorProvisaoFeriasVencidas": 960,
"avosFeriasProporcionais": 9.85,
"mediasFeriasProporcionais": 0,
"valorProvisaoFeriasProporcionais": 110.23,
"valorAbatimentoFerias": 1083.8,
"valorSemAbatimentoFerias": 1083.8,
"valorProvisaoFerias": 4400.97,
"avos13": 9.9,
"medias13Salario": 15.96,
"valorProvisao13": 792
} |
| Expandir |
|---|
| Status Code: 201 Created
{
"codigoColigada":1,
"ano":2024,
"mes":7,
"chapa":"F0002",
"dataVencimentoFerias":"2025-02-01T00:00:00-03:00",
"valorPagoFeriasMes":0.0,
"valorProvisaoFeriasEmDobro":210.46,
"avosFeriasVencidos":24.0,
"mediasFeriasVencidas":150.0,
"valorProvisaoFeriasVencidas":960.0,
"avosFeriasProporcionais":9.85,
"mediasFeriasProporcionais":0.0,
"valorProvisaoFeriasProporcionais":110.23,
"valorAbatimentoFerias":1083.8,
"valorSemAbatimentoFerias":1083.8,
"valorProvisaoFerias":4400.97,
"avos13":9.9,
"medias13Salario":15.96,
"valorProvisao13":792.0
} |
| Edição | Registro | Para análise rápida, importe a seguinte collection no Postman:
| View file |
|---|
| name | HistoricoProvisao.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.json |
|---|
| height | 150 |
|---|
|
|
|
| Expandir |
|---|
|
Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C CHAPA ( Este end point é dinâmico, onde o que 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: POSTPUT Objetivo: Alterar um registro já incluido anteriormente
| Expandir |
|---|
| title | Exemplo de requisição |
|---|
| {
"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
} |
| 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.0,
"valorProvisaoFeriasProporcionais":0.0,
"valorAbatimentoFerias":4400.97,
"valorSemAbatimentoFerias":4400.97,
"valorProvisaoFerias":4400.97,
"avos13":2.0,
"medias13Salario":0.0,
"valorProvisao13":323.18
} |
| Exclusão | Registro | Para análise rápida, importe a seguinte collection no Postman:
| View file |
|---|
| name | HistoricoProvisaoUpdate.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_update.json |
|---|
| height | 150 |
|---|
|
|
|
| Expandir |
|---|
| title | Exclusão de Registro |
|---|
|
Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA 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
é 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
| 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 | HistoricoProvisaoDelete.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_delete.json |
|---|
| height | 150 |
|---|
|
| | Expandir |
|---|
| Status Code: 204 No Content
|
|
