Foi criada a API para uso do produto TOTVS Folha de Pagamento, que será utilizada na nova tela "Período de Apuração", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Período de Apuração que já conhecíamos anteriormente.

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/EsocialMonthlySheet
Método: GET
Objetivo: Retorna todos os Históricos Salariais

Endpoint:  //api/rh/v1/EsocialMonthlySheet
Método: POST
Objetivo: Incluir registro no Histórico Salarial

Status Code: 201 Created

{
    "companyId": 1,
    "employeeRegistration": "00001",
    "changeDate": "2011-09-01T00:00:00-03:00",    
    "salaryNro": 1,
    "processingDate": "2011-09-01T00:00:00-03:00",
    "salary": 291.60,
    "reasonChange": "08",
    "changeJourney": 0,
    "salaryHour": 0.0,
    "percentageApplied": 0.0,
    "includedDate": "2025-01-01T00:00:00-03:00",
    "journey": "0",
    "reference": "0",
    "journeyChar": "000:00"
}


Endpoint:   /api/rh/v1/EsocialMonthlySheet/1|00001|1314846000|1 CODCOLIGADA / CHAPA / DATA MUDANÇA/ NRO SALÁRIO 
Método:  PUT
Objetivo: Alterar um registro já incluido anteriormente
Observação: A data de mudança deve ser informada no formato de segundos*

Status Code: 200  OK

{
    
}

Endpoint:   /api/rh/v1/EsocialMonthlySheet/1|00001|1314846000|1 CODCOLIGADA / CHAPA / DATA MUDANÇA/ NRO SALÁRIO 
Método:  DELETE
Objetivo: Excluir um registro já incluído anteriormente
Observação: A data de mudança deve ser informada no formato de segundos*

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.

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