Versões comparadas

Chave

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

...

Informações Técnicas das API's utilizadas 

Expandir
titleSchemaRetorna Registros

Endpoint:  //api/rh/v1/SalaryHistory/Schema
Método:
GET
Objetivo: 
Retornar o Schema neste endpoint, com propriedades e tipos de dadosRetorna todos os Históricos Salariais

Expandir
titleInclusão de Registro

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

Expandir
titleExemplo de Retorno

Status Code: 201 Created

{
    "titlecompanyId": "Histórico Salarial"1,
    "versionemployeeRegistration": "1.000001",
    "identifierchangeDate": "HistoricoSalarial2011-09-01T00:00:00-03:00",    
    "fieldssalaryNro": [1,
        {
        "processingDate": "2011-09-01T00:00:00-03:00",
    "salary": 291.60,
    "layoutDefinitionreasonChange": ["08",
                {
                "changeJourney": 0,
    "visiblesalaryHour": false0.0,
                    "componentTypepercentageApplied": 0.0,
    "includedDate": "2025-01-01T00:00:00-03:00",
    "journey": "0",
    "reference": "0",
    "journeyChar": "000:00"
}


Expandir
titleEdição de Registro

Endpoint:   /api/rh/v1/SalaryHistory/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*

Expandir
titleExemplo de Retorno

Status Code: 200  OK

{
    "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": "02",
    "changeJourney": 0,
    "salaryHour": 0.0,
    "percentageApplied": -0.0,
    "includedDate": "2025-01-01T00:00:00-03:00",
    "journey": "0",
    "reference": "0",
    "journeyChar": "000:00"
}

Expandir
titleExclusão de Registro

Endpoint:   /api/rh/v1/SalaryHistory/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*

Expandir
titleExemplo de Retorno

Status Code: 204  No Content

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

View file
nameHistórico Salarial.postman_collection.json
height250

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.

Expandir
titleSchema

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

Endpoint:  //api/rh/v1/SalaryHistory
Método:
POST
Objetivo:
Expandir
titleExemplo de Retorno

 "title": "Histórico Salarial",
    "version": "1.0",
    "identifier": "HistoricoSalarial",
    "fields": ["TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "companyId",
            "label": "Coligada",
            "disabled": true,
            "visible": false,
            "type": "string",
            "componentType": "Input"
        },
        {
            "layoutDefinition": [
                {
                    "order": 1,
                    "componentType": "TableLayout"
                },
                {
                    "disabled": true,
                    "gridColumns": 6,
                    "order": 1,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 12,
                    "order": 1,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "employeeRegistration",
            "label": "Matrícula",
            "disabled": true,
            "type": "string",
            "componentType": "Input"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "ordervisible": 2false,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumnsvisible": 6false,
                    "order": 2,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumnscomponentType": 4,"DetailLayout"
                }
    "order": 2,
        ],
            "componentTypekey": "DetailLayout"true,
                }"property": "companyId",
            ]"label": "Coligada",
            "propertydisabled": "changeDate"true,
            "labelvisible": "Data da Mudança"false,
            "type": "datestring",
            "componentType": "DatePickerInput"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "visibleorder": false1,
                    "componentType": "TableLayout"
                },
                {
                    "visibledisabled": falsetrue,
                    "componentTypegridColumns": "EditLayout"6,
                },
                {    "order": 1,
                    "visible": falsecomponentType": "EditLayout"
                },
                {
                    "gridColumns": 12,
                    "order": 1,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "changeDatePKemployeeRegistration",
            "label": "Data da Mudança""Matrícula",
            "disabled": true,
            "type": "datestring",
            "componentType": "DatePickerInput"
        },
        {
            "layoutDefinitionformat": ["dd/MM/yyyy",
              "layoutDefinition": [
                {
                    "order": 32,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 26,
                    "order": 32,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "order": 32,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "salaryNrochangeDate",
            "label": "Nro. SalárioData da Mudança",
            "type": "stringdate",
            "componentType": "InputDatePicker"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "ordervisible": 9false,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 6,
                    "visible": false,
                    "order": 9,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumnsvisible": 4false,
                    "ordercomponentType": 9,"DetailLayout"
                    "componentType": "DetailLayout"}
                }],
            ]"key": true,
            "property": "processingDatechangeDatePK",
            "label": "Data Processamentoda Mudança",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "maxLength": 6,
            "layoutDefinition": [
                {
                    "order": 43,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 2,
                    "order": 43,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "order": 43,
                    "componentType": "DetailLayout"
                }
            ],
            "key": true,
            "property": "journeyCharsalaryNro",
            "label": "JornadaNro. Salário",
            "type": "string",
            "componentType": "Input"
        },
        {
            "decimalsLengthformat": 2,
            "thousandMaxlength": 9999999"dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "order": 59,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 26,
                    "ordervisible": 5false,
                    "componentTypeorder": "9,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "order": 59,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "salaryprocessingDate",
            "label": "SalárioData Processamento",
            "type": "currencydate",
            "componentType": "DecimalDatePicker"
        },
        {
            "maxLength": 6,
            "layoutDefinition": [
                {
                    "order": 64,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 2,
                    "order": 64,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "order": 64,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "eventIdjourneyChar",
            "label": "Código do eventoJornada",
            "type": "string",
            "componentType": "Input"
        },
        {
            "maxLengthdecimalsLength": 62,
            "layoutDefinitionthousandMaxlength": [9999999,
                {"layoutDefinition": [
                    "visible": false,{
                    "order": 45,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 2,
                    "visibleorder": false5,
                    "ordercomponentType": 7,"EditLayout"
                    "componentType": "EditLayout"
                },
      },
                {
                    "gridColumns": 4,
                    "visible": false,
                    "order": 75,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "referenceCharsalary",
            "label": "ReferênciaSalário",
            "type": "stringcurrency",
            "componentType": "InputDecimal"
        },
        {
            "quickFilter": true,
            "columnslayoutDefinition": [
                {
                    "fieldLabelorder": false6,
                    "labelcomponentType": "CódigoTableLayout",
                    "property": "code"
                },
                {
                    "fieldLabelgridColumns": false2,
                    "labelorder": "Descrição"6,
                    "propertycomponentType": "descriptionEditLayout"
                },
            ],
    {
        "required": true,
            "searchServicegridColumns": "/api/rh/v1/readonly/lookups/generic/reasonChange",
4,
                    "formatorder": [6,
                    "componentType": "codeDetailLayout",
                "description"}
            ],
            "fieldLabelproperty": "codeeventId",
            "fieldValuelabel": "codeCódigo do evento",
            "layoutDefinitiontype": ["string",
                {"componentType": "Input"
        },
            "order": 7,
        {
            "componentTypemaxLength": "TableLayout"6,
                },"layoutDefinition": [
                {
                    "gridColumnsvisible": 6false,
                    "order": 84,
                    "componentType": "EditLayoutTableLayout"
                },
            ],
    {
        "clean": true,
            "noAutoCompletegridColumns": true2,
                    "propertyvisible": "reasonChange"false,
                    "labelorder": "Motivo da Mudança"7,
                    "componentType": "LookupEditLayout"
                },
        {
        {
    "layoutDefinition": [
                {"gridColumns": 4,
                    "visible": false,
                    "order": 7,
                    "componentType": "TableLayoutDetailLayout"
                },
            ],
    {
        "property": "referenceChar",
            "visiblelabel": false"Referência",
            "type": "string",
            "componentType": "EditLayoutInput"
                },
                {
                    "visiblequickFilter": falsetrue,
                    "componentTypecolumns": "DetailLayout"[
                }{
            ],
            "propertyfieldLabel": "descriptionReason"false,
                    "label": "Desc. MotivoCódigo",
            "type": "string",
            "componentTypeproperty": "Inputcode"
        },
        {
            "columns": [},
                {
                    "fieldLabel": false,
                    "label": "Cód da Tabela SalarialDescrição",
                    "property": "codedescription"
                },
                {
      ],
              "fieldLabelrequired": falsetrue,
                    "labelsearchService": "Tabela/api/rh/v1/readonly/lookups/generic/reasonChange",
            "format": [
        "property": "description"
                }
            ],
            "searchService": "/api/rh/v1/readonly/lookups/generic/salaryHistoryTable",
            "format": [
                "        "code",
                "description"
            ],
            "fieldLabel": "code",
            "fieldValue": "code",
            "layoutDefinition": [
                {
                    "visible": false,
                    "order": 7,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 6,
                    "order": 108,
                    "componentType": "EditLayout"
                }
            ],
            "clean": true,
            "noAutoComplete": true,
            "property": "salaryHistoryTablereasonChange",
            "label": "Histórico Tabela Salarial",
            "visible": falseMotivo da Mudança",
            "componentType": "Lookup"
        },
        {
            "columnslayoutDefinition": [
                {
                    "fieldLabelorder": false7,
                    "labelcomponentType": "Código identificador",
                    "property": "code"TableLayout"
                },
                {
                    "fieldLabelvisible": false,
                    "labelcomponentType": "FaixaEditLayout",
                    "property": "description"
                },
                {
                    "fieldLabelvisible": false,
                    "labelcomponentType": "Percentual do Valor de RefrênciaDetailLayout",
                    "property": "complementaryField"}
                }
            ]],
            "searchServiceproperty": "/api/rh/v1/readonly/lookups/generic/salaryRangeHistorydescriptionReason",
            "formatlabel": [
                "code"Desc. Motivo",
                "description"
            ]"type": "string",
            "fieldLabelcomponentType": "codeInput",
        },
        "fieldValue": "code",{
            "layoutDefinitioncolumns": [
                {
                    "visiblefieldLabel": false,
                    "orderlabel": 7"Cód da Tabela Salarial",
                    "componentTypeproperty": "TableLayoutcode"
                },
                {
                    "gridColumnsfieldLabel": 6false,
                    "orderlabel": 11"Tabela",
                    "componentTypeproperty": "EditLayoutdescription"
                }
            ],
            "cleansearchService": true"/api/rh/v1/readonly/lookups/generic/salaryHistoryTable",
            "noAutoCompleteformat": true,[
                "property": "salaryRangeHistorycode",
            "label": "Histórico de Faixa",    "description"
            "visible": false],
            "componentTypefieldLabel": "Lookupcode",
        },
        {"fieldValue": "code",
            "columnslayoutDefinition": [
                {
                    "fieldLabelvisible": false,
                    "labelorder": "Código identificador"7,
                    "propertycomponentType": "codeTableLayout"
                },
                {
                    "fieldLabelgridColumns": false6,
                    "labelorder": "Nome do Nível"10,
                    "propertycomponentType": "descriptionEditLayout"
                }
            ],
            "searchServiceclean": "/api/rh/v1/readonly/lookups/generic/salaryLevelHistory"true,
            "formatnoAutoComplete": [true,
                "code"property": "salaryHistoryTable",
                "description""label": "Histórico Tabela Salarial",
            ]"visible": false,
            "fieldLabelcomponentType": "codeLookup",
        },
        "fieldValue": "code",{
            "layoutDefinitioncolumns": [
                {
                    "visiblefieldLabel": false,
                    "orderlabel": 7"Código identificador",
                    "componentTypeproperty": "TableLayoutcode"
                },
                {
                    "gridColumnsfieldLabel": 6false,
                    "orderlabel": 12"Faixa",
                    "componentTypeproperty": "EditLayoutdescription"
                },
            ],
    {
        "clean": true,
            "noAutoCompletefieldLabel": truefalse,
            "property": "salaryLevelHistory",
            "label": "Histórico Percentual do Valor de NívelRefrência",
            "visible": false,
            "componentTypeproperty": "LookupcomplementaryField"
        },
        {}
            "layoutDefinition": [
    ],
            {
                    "order": 15,
        "searchService": "/api/rh/v1/readonly/lookups/generic/salaryRangeHistory",
            "componentTypeformat": "TableLayout"[
                }"code",
                {"description"
            ],
            "disabledfieldLabel": true"code",
            "fieldValue": "code",
            "gridColumnslayoutDefinition": 2,[
                {
                    "visible": false,
                    "order": 127,
                    "componentType": "EditLayoutTableLayout"
                },
                {
                    "visiblegridColumns": false6,
                    "componentTypeorder": "DetailLayout"11,
                }
            ]    "componentType": "EditLayout"
                }
            ],
            "clean": true,
            "noAutoComplete": true,
            "property": "changeJourneysalaryRangeHistory",
            "label": "Alteração Histórico de JornadaFaixa",
            "typevisible": "string"false,
            "componentType": "InputLookup"
        },
        {
            "layoutDefinitioncolumns": [
                {
                    "order": 5"fieldLabel": false,
                    "label": "Código identificador",
                    "componentTypeproperty": "TableLayoutcode"
                },
                {
                    "visiblefieldLabel": false,
                    "componentTypelabel": "EditLayoutNome do Nível",
                  },  "property": "description"
                {}
            ],
            "visiblesearchService": false"/api/rh/v1/readonly/lookups/generic/salaryLevelHistory",
            "format": [
                "componentType"code",: "DetailLayout"
                }"description"
            ],
            "propertyfieldLabel": "percentagecode",
            "labelfieldValue": "% Variação Salarialcode",
            "typelayoutDefinition": "string",[
            "componentType": "Input"
        },{
        {
            "decimalsLengthvisible": 2false,
            "thousandMaxlength": 9999999,
            "layoutDefinitionorder": [
                {7,
                    "ordercomponentType": 6,"TableLayout"
                },
    "componentType": "TableLayout"
            {
    },
                {"gridColumns": 6,
                    "visibleorder": false12,
                    "componentType": "EditLayout"
                },
            ],
    {
        "clean": true,
            "visiblenoAutoComplete": falsetrue,
            "property": "salaryLevelHistory",
            "componentTypelabel": "DetailLayoutHistórico de Nível",
                }
            ],
            "property": "salaryHour",
            "label": "Salário Hora""visible": false,
            "type": "currency",
            "componentType": "DecimalLookup"
        },
        {
            "layoutDefinition": [
                {
                    "order": 715,
                    "componentType": "TableLayout"
                },
                {
                    "visibledisabled": falsetrue,
                    "componentTypegridColumns": "EditLayout"2,
                },
                {    "visible": false,
                    "visibleorder": false12,
                    "componentType": "DetailLayoutEditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "percentageHourchangeJourney",
            "label": "% Salário HoraAlteração de Jornada",
            "type": "string",
            "componentType": "Input"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "order": 75,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "monthlyPercentagepercentage",
            "label": "% Salário MensalVariação Salarial",
            "type": "string",
            "componentType": "Input"
        },
        {
            "layoutDefinitiondecimalsLength": [2,
              "thousandMaxlength": 9999999,
            "layoutDefinition": [
                {
                    "order": 116,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "percentageAppliedsalaryHour",
            "label": "% AplicadoSalário Hora",
            "type": "numbercurrency",
            "componentType": "NumberDecimal"
        },
        {
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "order": 127,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "includedDatepercentageHour",
            "label": "Data de Inlusão% Salário Hora",
            "type": "datestring",
            "componentType": "DatePickerInput"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "order": 147,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "journeymonthlyPercentage",
            "label": "Jornada% Salário Mensal",
            "type": "numberstring",
            "componentType": "NumberInput"
        },
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "order": 1411,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "referencepercentageApplied",
            "label": "Referência% Aplicado",
            "type": "stringnumber",
            "componentType": "InputNumber"
        }
    ],
    "groups": []
}     

Expandir
titleInclusão de Registro

 

Incluir registro no Histórico Salarial
Expandir
titleExemplo de Retorno

Status Code: 201 Created

Endpoint:   /api/rh/v1/SalaryHistory/1|00007|2011-09-02|1 CODCOLIGADA / CHAPA / DATA MUDANÇA/ NRO SALÁRIO 
Método:  PUTObjetivo: Alterar um registro já incluido anteriormente
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:
Expandir
titleExemplo de requisição
Expandir
titleExemplo de Retorno

Status Code: 200  OK

  {
            "companyIdformat": 1"dd/MM/yyyy",
            "employeeRegistrationlayoutDefinition": "00001",
[
                {
                    "changeDateorder": "2011-09-05T00:00:00-03:00"12,
                    "reasoncomponentType": "01TableLayout",
                "salaryNro": 1},
                "salary": 4000,
{
                    "journeyvisible": 220false,
                    "includedDatecomponentType": "2025-03-02T00:00:00-03:00",
"EditLayout"
                },
                {
                    "processingDatevisible": "2011-09-05T00:00:00-03:00"false,
                    "changeJourneycomponentType": 0,
"DetailLayout"
                "percentageApplied": 0.0,}
            "reference": 0.0],
            "journeyCharproperty": "000:00includedDate",
          }

Expandir
titleExemplo de utilização
Expandir
titleEdição de Registro
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:

   "label": "Data de Inlusão",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "companyIdlayoutDefinition": 1,[
                "employeeRegistration": "00001",{
                    "changeDateorder": "2011-09-05T00:00:00-03:00"14,
                    "reasoncomponentType": "01TableLayout",
              "salaryNro": 1  },
                "salary": 4000,
{
                    "journeyvisible": 220false,
                    "includedDatecomponentType": "2025-03-02T00:00:00-03:00",
EditLayout"
                "processingDate": "2011-09-05T00:00:00-03:00"},
            "changeJourney": 0    {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "percentageAppliedproperty": 0.0"journey",
            "referencelabel": 0.0"Jornada",
            "journeyChartype": "000:00"number",
            "componentType": "Number"
        }

Expandir
titleExemplo de utilização
Expandir
titleExclusão de Registro
Endpoint:   /api/rh/v1/SalaryHistory/1|00007|2011-09-02|1 CODCOLIGADA / CHAPA / DATA MUDANÇA/ NRO SALÁRIO 
Método:  DELETE

Objetivo: Excluir um registro já incluído anteriormente

Expandir
titleExemplo de Retorno

Status Code: 204  No Content

Expandir
titleExemplo de utilização

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:,
        {
            "layoutDefinition": [
                {
                    "visible": false,
                    "order": 14,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {
                    "visible": false,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "reference",
            "label": "Referência",
            "type": "string",
            "componentType": "Input"
        }
    ],
    "groups": []
}