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.

...

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",
    {
        "maskFormatModel": true,
            "maxLengthcomponentType": 4,"TableLayout"
            "layoutDefinition": [    },
                {
                    "gridColumnscomponentType": 2"EditLayout"
                },
                {
                    "componentType": "EditLayoutDetailLayout"
                }
            ],
            "locale": "pt-BR",
            "key": true,
            "property": "iddthrinicio",
            "label": "IdentificadorData Inicio",
            "type": "stringdate",
            "componentType": "InputDatePicker"
        },
        {
            "quickFilterformat": true,
            "maxLength": 12"dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumnscomponentType": 4"TableLayout"
                },
                {
                    "componentType": "EditLayout"
                },
            ],
    {
        "property": "numeroLei",
            "labelcomponentType": "Número da Lei do reajuste retroativo",DetailLayout"
            "type    }
            ],
            "property": "stringdataFim",
            "componentTypelabel": "InputData Fim",
        },
        {"disabled": true,
            "quickFiltertype": true"date",
            "optionscomponentType": ["DatePicker"
        },
        {
                    "valuelayoutDefinition": 1,[
                {
      "label              "componentType": "JaneiroTableLayout"
                },
                {
                    "valuecomponentType": 2,
                    "label": "Fevereiro"EditLayout"
                },
                {
                    "valuecomponentType": 3,"DetailLayout"
                    "label": "Março"}
                }],
                {
      "property": "computador",
              "valuelabel": 4"Máquina utilizada",
            "disabled": true,
            "labeltype": "Abrilstring",
            "componentType": "Input"
        },
        {
        {
    "layoutDefinition": [
                "value": 5,{
                    "labelcomponentType": "MaioTableLayout"
                },
                {
                    "valuecomponentType": 6,"EditLayout"
                    "label": "Junho},
                {
                    "componentType": "DetailLayout"
                },
            ],
    {
        "property": "usuario",
            "valuelabel": 7"Usuário",
            "disabled": true,
            "labeltype": "Julhostring",
            "componentType": "Input"
        },
                {
                    "valuequickFilter": 8true,
                    "labeloptions": "Agosto"[
                },
                {
                    "value": 90,
                    "label": "SetembroFolha"
                },
                {
                    "value": 101,
                    "label": "OutubroRecalculo"
                },
                {
                    "value": 112,
                    "label": "NovembroDiferença Salarial"
                },
                {
                    "value": 123,
                    "label": "DezembroImportação"
                }
            ],
            "layoutDefinition": [
                {
                    "gridColumnsvalue": 34,
                    "componentTypelabel": "EditLayoutImportação Centro de Custo"
                },
                {
                    "visiblevalue": false5,
                    "componentTypelabel": "TableLayoutCancelamento do Movimento"
                },
            ],
    {
        "forceOptionsComponentType": "select",
            "propertyvalue": "mesCompPagto"6,
                    "label": "Mês Pagamento",
Lançamento de 13º 1º Parcela"
                "componentType": "Select"},
        },
        {
                    "quickFiltervalue": true7,
            "mask": "9999",
            "maskFormatModellabel": true,"Lançamento de 13º 2ª Parcela"
            "maxLength": 4,
            "layoutDefinition": [    },
                {
                    "gridColumnsvalue": 38,
                    "componentTypelabel": "EditLayoutDiferença de 13º"
                },
                {
                    "visiblevalue": false9,
                    "componentTypelabel": "TableLayoutProvisão de 13º"
                },
                ],{
                    "propertyvalue": "anoCompPagto"10,
                    "label": "Ano PagamentoCálculo de Férias",
            "type": "string"    },
            "componentType": "Input"
        },{
        {
            "formatvalue": "dd/MM/yyyy"11,
                    "layoutDefinitionlabel": ["Cálculo de Férias Coletivas"
                },
                {
                    "gridColumnsvalue": 312,
                    "componentTypelabel": "EditLayoutLançamento de Férias"
                },
            ],
    {
        "property": "dtAcordo",
            "labelvalue": "Data da assinatura do acordo"13,
                    "typelabel": "dateFinalização de Férias",
            "componentType": "DatePicker"
        },
        {
          {
                    "formatvalue": "dd/MM/yyyy"14,
                    "layoutDefinitionlabel": ["Diferença de Férias"
                },
                {
                    "gridColumnsvalue": 315,
                    "componentTypelabel": "EditLayoutProvisão de Férias"
                },
            ],
    {
        "property": "dtEfeito",
            "labelvalue": "Data do efeito"16,
                    "typelabel": "dateCancelamento de Férias",
            "componentType": "DatePicker"    },
        },
        {
                    "quickFiltervalue": true17,
                    "requiredlabel": true,"Acerta Período Aquisitivo"
            "options": [    },
                {
                    "value": "A"18,
                    "label": "A - Acordo Coletivo de TrabalhoAd. Férias Portugal"
                },
                {
                    "value": "B"19,
                    "label": "B - Legislação federal, estadual, municipal ou distritalConversão de Férias Portugal"
                },
                {
                    "value": "C"20,
                    "label": "C - Convenção Coletiva de TrabalhoCálculo de Rescisão"
                },
                {
                    "value": "D"21,
                    "label": "D - Sentença Normativa - DissídioLíquido de Rescisão"
                },
                {
                    "value": "E"22,
                    "label": "E - Conversão de Licença Saúde em Acidente de TrabalhoRescisão Complementar"
                },
                {
                    "value": "F",23,
                    "label": "F - Outras verbas de natureza salarial ou não salarial devidas após o desligamentoCancelamento de Rescisão"
                },
                {
                    "value": "G"24,
                    "label": "G - Antecipação de diferenças de Acordo, Convenção ou Dissídio ColetivoSefip"
                },
                {
                    "value": "I"25,
                    "label": "I - Sentença judicial (exceto reclamatória trabalhista)GRRF"
                },
                {
                    "value": "J"26,
                    "label": "J - Parcelas complementares conhecidas após o fechamento da folhaCAGED"
                }
            ],
            "layoutDefinition": [
                {
                    "gridColumnsvisible": 6false,
                    "componentType": "EditLayoutTableLayout"
                },
                {
                    "visible": false,
                    "componentType": "TableLayoutEditLayout"
                },
            ],
    {
        "forceOptionsComponentType": "select",
            "propertyvisible": "tpAcordo"false,
            "label": "Tipo do acordo",
            "componentType": "SelectDetailLayout"
        },
        {
            "layoutDefinition": [},
                {
                    "visiblegridColumns": false5,
                    "componentType": "EditLayoutFilterLayout"
                },
                {],
            "forceOptionsComponentType": "select",
            "visibleproperty": false"tipoProcesso",
            "label": "Tipo de Cálculo",
            "componentType": "AdvancedFilterLayoutSelect"
                },
        {
        {
    "layoutDefinition": [
                "visible": false,{
                    "componentType": "FilterLayoutTableLayout"
                },
                {
                    "visiblecomponentType": false,
"EditLayout"
                },
        "componentType        {
                    "componentType": "DetailLayout"
                }
            ],
            "property": "tpAcordoTextoTableLayoutnomeTipoProcesso",
            "label": "Tipo do Acordode Processo",
            "disabled": true,
            "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