Páginas filhas
  • API - Documentação Técnica - Histórico de Provisão

Versões comparadas

Chave

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

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á conheciamos anteriormenteconhecí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 

...

Expandir
titleEdição de Registro

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

Expandir
titleExemplo 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
titleExemplo de Retorno

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
}

Expandir
titleEdição Exclusão de Registro

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

Expandir
titleExemplo de Retorno

Status Code: 204  No Content