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 Períodos de Apurações

Endpoint:  //api/rh/v1/EsocialMonthlySheet
Método: POST
Objetivo: Incluir registro no Período de Apuração

Status Code: 201 Created

{
            "companyId": 1,
            "monthComp": 9,
            "yearComp": 2015,
            "indPeriod": 1,
            "generateTaker": 0,
            "law11774ReductionPercentage": 0.00,
            "employerSubsidyIndicator": 0,
            "employerContributionPercentage": 0.00,
            "monthlyFactor": 0.00,
            "thirteenthMonthFactor": 0.00,
            "compWithoutMovement": 0,
            "ruralProductionAcquisitionIndicator": 0,
            "excludeRuralProductionAcquisitionInfo": 0,
            "immediateDctfWebTransmission": 0,
            "finalProfitSocialContributionPercentage": 0,
            "indicativeDoesNotValidateClosing": 0,
            "retentionValue": 0.00
}


Endpoint:   /api/rh/v1/EsocialMonthlySheet/1|1|2015|9 CODCOLIGADA / Indicativo de Período de Apuração /  ANO / MÊS
Método:  PUT
Objetivo: Alterar um registro já incluido anteriormente

Status Code: 200  OK

{
            "companyId": 1,
            "monthComp": 10,
            "yearComp": 2015,
            "indPeriod": 1,
            "generateTaker": 0,
            "law11774ReductionPercentage": 0.00,
            "employerSubsidyIndicator": 0,
            "employerContributionPercentage": 0.00,
            "monthlyFactor": 0.00,
            "thirteenthMonthFactor": 0.00,
            "compWithoutMovement": 0,
            "ruralProductionAcquisitionIndicator": 0,
            "excludeRuralProductionAcquisitionInfo": 0,
            "immediateDctfWebTransmission": 0,
            "finalProfitSocialContributionPercentage": 0,
            "indicativeDoesNotValidateClosing": 0,
            "retentionValue": 0.00
}


Endpoint:   /api/rh/v1/EsocialMonthlySheet/1|1|2015|9  CODCOLIGADA / Indicativo de Período de Apuração /  ANO / MÊS
Método:  DELETE
Objetivo: Excluir um registro já incluído 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.

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