Páginas filhas
  • API - Documentação Técnica - Gerenciador do Log de Cálculo

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 do produto TOTVS Folha de Pagamento das linhas RM, Datasul e Protheus, que será utilizada na nova tela "Gerenciador do Log de Cálculo", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Gerenciador do Log de Cálculo que já conhecíamos anteriormente.

...

Endpoint:  /api/rh/v1/DadosDissidio/
Método:
POST
Objetivo:
Incluir registros na pagina de Gerenciador do Log de Cálculo
Expandir
titleSchema

Endpoint:  /api/rhrhv1/v1GerenciadorLogCalculo/DadosDissidio/Schema
Método:
GET
Objetivo: 
Retornar o Schema utilizado neste endpoint, com propriedades e tipos de dados

Expandir
titleExemplo de Retorno

{
    "title": "Dados DissidioGerenciador de Log de Cálculo",
    "version": "1.0",
    "identifier": "DadosDissidioGerenciadorLogCalculo",
    "fields": [
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "codColigadaexecId",
            "label": "ColigadaId de Execução",
            "disabled": true,
            "visible": false,
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilterformat": true"dd/MM/yyyy",
            "requiredlayoutDefinition": true,[
                "mask": "9999",
{
                    "componentType": "TableLayout"
              "maskFormatModel": true  },
                "maxLength": 4,
{
                    "layoutDefinitioncomponentType": ["EditLayout"
                {},
                    "gridColumns": 2,{
                    "componentType": "EditLayoutDetailLayout"
                }
            ],
            "keylocale": true"pt-BR",
            "propertykey": "idtrue,
            "property": "dthrinicio",
            "label": "IdentificadorData Inicio",
            "type": "stringdate",
            "componentType": "InputDatePicker"
        },
        {
            "quickFilterformat": true,
            "maxLength": 12"dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumnscomponentType": 4"TableLayout"
                },
                {
                    "componentType": "EditLayout"
                },
                {
                    "componentType": "DetailLayout"
                }
            ],
            "property": "numeroLeidataFim",
            "label": "Número da Lei do reajuste retroativo"Data Fim",
            "disabled": true,
            "type": "stringdate",
            "componentType": "InputDatePicker"
        },
        {
            "quickFilterlayoutDefinition": true,[
            "options": [    {
                    "componentType": "TableLayout"
                {},
                    "value": 1,{
                    "labelcomponentType": "JaneiroEditLayout"
                },
                {
                    "valuecomponentType": 2,"DetailLayout"
                    "label": "Fevereiro"}
                }],
                {"property": "computador",
            "label": "Máquina utilizada",
            "valuedisabled": 3true,
            "type": "string",
            "labelcomponentType": "MarçoInput"
                },
        {
        {
    "layoutDefinition": [
                "value": 4,{
                    "labelcomponentType": "AbrilTableLayout"
                },
                {
                    "valuecomponentType": 5,
"EditLayout"
                },
        "label        {
                    "componentType": "MaioDetailLayout"
                },
            ],
    {
        "property": "usuario",
            "valuelabel": 6"Usuário",
            "disabled": true,
            "labeltype": "Junhostring",
            "componentType": "Input"
        },
                {
            "quickFilter": true,
            "options": [
                {
                    "value": 70,
                    "label": "JulhoFolha"
                },
                {
                    "value": 81,
                    "label": "AgostoRecalculo"
                },
                {
                    "value": 92,
                    "label": "SetembroDiferença Salarial"
                },
                {
                    "value": 103,
                    "label": "OutubroImportação"
                },
                {
                    "value": 114,
                    "label": "NovembroImportação Centro de Custo"
                },
                {
                    "value": 125,
                    "label": "DezembroCancelamento do Movimento"
                },
            ],
            "layoutDefinition": [
                {
                    "gridColumnsvalue": 36,
                    "componentTypelabel": "EditLayoutLançamento de 13º 1º Parcela"
                },
                {
                    "visiblevalue": false7,
                    "componentTypelabel": "TableLayoutLançamento de 13º 2ª Parcela"
                },
            ],
    {
                    "forceOptionsComponentTypevalue": "select"8,
                    "propertylabel": "mesCompPagtoDiferença de 13º",
            "label": "Mês Pagamento"    },
            "componentType": "Select"
        },{
        {
            "quickFiltervalue": true9,
                    "masklabel": "9999Provisão de 13º",
                "maskFormatModel": true},
                "maxLength": 4,
{
                    "layoutDefinitionvalue": [10,
                {
    "label": "Cálculo de Férias"
                "gridColumns": 3},
                {
                    "value": 11,
                    "componentTypelabel": "EditLayoutCálculo de Férias Coletivas"
                },
                {
                    "visiblevalue": false12,
                    "componentTypelabel": "TableLayoutLançamento de Férias"
                },
            ],
    {
        "property": "anoCompPagto",
            "labelvalue": "Ano Pagamento"13,
            "type": "string",
            "componentTypelabel": "InputFinalização de Férias"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [},
                {
                    "gridColumnsvalue": 314,
                    "componentTypelabel": "EditLayoutDiferença de Férias"
                },
            ],
    {
                    "propertyvalue": "dtAcordo"15,
                    "label": "Data da assinatura do acordo",
Provisão de Férias"
                "type": "date"},
            "componentType": "DatePicker"
        },{
        {
            "formatvalue": "dd/MM/yyyy"16,
                    "layoutDefinitionlabel": ["Cancelamento de Férias"
                },
                {
                    "gridColumnsvalue": 317,
                    "componentTypelabel": "EditLayoutAcerta Período Aquisitivo"
                },
                ],{
                    "propertyvalue": "dtEfeito"18,
                    "label": "Data do efeito",Ad. Férias Portugal"
            "type": "date"    },
                "componentType": "DatePicker"
        },{
        {
            "quickFiltervalue": true19,
                    "requiredlabel": true,"Conversão de Férias Portugal"
            "options": [    },
                {
                    "value": "A"20,
                    "label": "A - Acordo Coletivo de TrabalhoCálculo de Rescisão"
                },
                {
                    "value": "B"21,
                    "label": "B - Legislação federal, estadual, municipal ou distrital"
  Líquido de Rescisão"
                },
                {
                    "value": "C"22,
                    "label": "C - Convenção Coletiva de TrabalhoRescisão Complementar"
                },
                {
                    "value": "D"23,
                    "label": "D - Sentença Normativa - DissídioCancelamento de Rescisão"
                },
                {
                    "value": "E"24,
                    "label": "E - Conversão de Licença Saúde em Acidente de TrabalhoSefip"
                },
                {
                    "value": "F"25,
                    "label": "F - Outras verbas de natureza salarial ou não salarial devidas após o desligamentoGRRF"
                },
                {
                    "value": "G"26,
                    "label": "G - Antecipação de diferenças de Acordo, Convenção ou Dissídio ColetivoCAGED"
                }
            ],
            "layoutDefinition": [
                {
                    "valuevisible": "I"false,
                    "labelcomponentType": "I - Sentença judicial (exceto reclamatória trabalhista)TableLayout"
                },
                {
                    "valuevisible": "J"false,
                    "labelcomponentType": "J - Parcelas complementares conhecidas após o fechamento da folha"
  EditLayout"
                }
            ],
            "layoutDefinition": [
                {
                    "gridColumnsvisible": 6false,
                    "componentType": "EditLayoutDetailLayout"
                },
                {
                    "visiblegridColumns": false5,
                    "componentType": "TableLayoutFilterLayout"
                }
            ],
            "forceOptionsComponentType": "select",
            "property": "tpAcordotipoProcesso",
            "label": "Tipo do acordode Cálculo",
            "componentType": "Select"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "componentType": "EditLayoutTableLayout"
                },
                {
                    "visiblecomponentType": false,
                    "componentType": "AdvancedFilterLayout""EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "FilterLayoutDetailLayout"
                },
                {
        ],
            "visibleproperty": false"nomeTipoProcesso",
                    "componentTypelabel": "DetailLayoutTipo de Processo",
                }
            ],
            "property": "tpAcordoTextoTableLayout""disabled": true,
            "label ": "Tipo do Acordo",
            "type": "string",
            "componentType": "Input"
        },
        {
            "requiredlayoutDefinition": true,[
            "maxLength": 255,
    {
        "rows": 3,
            "layoutDefinitioncomponentType": ["TableLayout"
                {},
                    "gridColumns": 12,{
                    "componentType": "EditLayout"
                },
            ],
    {
        "property": "descricao",
            "labelcomponentType": "DescriçãoDetailLayout",
                "componentType": "TextArea"
}
            }],
            {"key": true,
            "booleanTrueproperty": "Simchapa",
            "booleanFalselabel": "NãoMatrícula",
            "layoutDefinitiondisabled": [true,
                {"type": "string",
            "componentType": "Input"
        },
        {
            "gridColumnslayoutDefinition": 12,[
                {
                    "componentType": "EditLayoutTableLayout"
                },
                ],{
                    "propertycomponentType": "sucessaoVinculoEditLayout",
                "label": "Pagamento de verbas devidas pela empresa sucessora a empregados desligados ainda na sucedida",},
            "type": "boolean",
    {
                    "componentType": "SwitchDetailLayout"
                }
            ],
            "groupsproperty": []
}

Expandir
titleInclusão de Registro
Expandir
titleExemplo de requisição

{
  "id": "12",
  "numeroLei": "21318",
  "mesCompPagto": 2,
  "anoCompPagto": "2025",
  "dtAcordo": "2025-01-01",
  "dtEfeito": "2025-12-31",
  "tpAcordo": "A",
  "descricao": "INCLUSAO Gerenciador do Log de Cálculo"
}

Expandir
titleExemplo de Retorno
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 Gerenciador do Log de Cálculo",
    "sucessaoVinculo": false
}

Expandir
titleExemplo de utilização
Para análise rápida, importe a seguinte collection no Postman:
View file
nameDadosDissidio API.postman_collection.json
height150
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
namemock_dados_do_dissidio_post.json
height150
Expandir
titleEdição de Registro
Endpoint:  /api/rh/v1/DadosDissidio/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 / NUMERO DO IDENTIFICADOR  )
Método:  PUTObjetivo: Alterar um registro já incluido anteriormente
Expandir
titleExemplo de requisição

{
  "codColigada": 1,
  "id": "13",
  "numeroLei": "342534",
  "mesCompPagto": 2,
  "anoCompPagto": "2025",
  "dtAcordo": "2024-01-01T00:00:00-03:00",
  "dtEfeito": "2025-12-31T00:00:00-03:00",
  "tpAcordo": "C",
  "tpAcordoTextoTableLayout": "C - Convenção Coletiva de Trabalho",
  "descricao": "teste mockoon 123",
  "sucessaoVinculo": false
}

Expandir
titleExemplo de Retorno

Status Code: 200  OK

{
    "codColigada": 1,
    "id": 13,
    "numeroLei": "342534",
    "mesCompPagto": 2,
    "anoCompPagto": 2025,
    "dtAcordo": "2024-01-01T00:00:00-03:00",
    "dtEfeito": "2025-12-31T00:00:00-03:00",
    "tpAcordo": "C",
    "tpAcordoTextoTableLayout": "C - Convenção Coletiva de Trabalho",
    "descricao": "teste mockoon 123",
    "sucessaoVinculo": false
}

Expandir
titleExemplo de utilização
Para análise rápida, importe a seguinte collection no Postman:
View file
nameDadosDissidio Update.postman_collection.json
height150
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
nameDadosDoDissidio Update.json
height150
Expandir
titleExclusão de Registro
Endpoint:   /api/rh/v1/DadosDissidio/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 / IDENTIFICADOR   )
Método:  DELETE

Objetivo: Excluir um registro já incluido anteriormente

Expandir
titleExemplo de Retorno

Status Code: 204  No Content

150"status",
            "label": "Status",
            "disabled": true,
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "layoutDefinition": [
                {
                    "componentType": "TableLayout"
                },
                {
                    "componentType": "EditLayout"
                },
                {
                    "componentType": "DetailLayout"
                }
            ],
            "property": "idJob",
            "label": "Id Job",
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "layoutDefinition": [
                {
                    "componentType": "TableLayout"
                },
                {
                    "componentType": "EditLayout"
                },
                {
                    "componentType": "DetailLayout"
                }
            ],
            "property": "idProcesso",
            "label": "Id Processo",
            "type": "string",
            "componentType": "Input"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "codColigada",
            "label": "Coligada",
            "disabled": true,
            "type": "string",
            "componentType": "Input"
        }
    ],
    "groups": []
}

Expandir
titleExemplo de utilização

Para análise rápida, importe a seguinte collection no Postman:

View file
nameDadosDissidio Delete.postman_collection.json
height150
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
namemock_dados_dissidio_delete.json
height