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
titleSchemaInclusão de Registro

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": -90.87,
    "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|00007|1314846000|1 CODCOLIGADA / CHAPA / DATA MUDANÇA/ NRO SALÁRIO 

Método:  PUT

Objetivo: Alterar um registro já incluido anteriormente

Expandir
titleExemplo de requisição



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": -90.87,
    "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|00007|1314846000|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:



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"
                }
            ],
            "keylayoutDefinition": true,[
            "property": "employeeRegistration",
    {
        "label": "Matrícula",
            "disabledvisible": truefalse,
            "type": "string",
            "componentType": "InputTableLayout"
                },
                {
                    "formatvisible": "dd/MM/yyyy",
false,
                    "layoutDefinitioncomponentType": ["EditLayout"
                {},
                    "order": 2,{
                    "componentType": "TableLayoutDetailLayout"
                },
            ],
    {
        "key": true,
            "gridColumnsproperty": 6"companyId",
            "label": "Coligada",
            "orderdisabled": 2true,
            "visible": false,
            "componentTypetype": "EditLayoutstring",
            "componentType": "Input"
        },
                {
              "layoutDefinition": [
                "gridColumns": 4,{
                    "order": 21,
                    "componentType": "DetailLayoutTableLayout"
                },
            ],
    {
        "property": "changeDate",
            "labeldisabled": "Data da Mudança"true,
                    "typegridColumns": "date"6,
            "componentType": "DatePicker"
        }"order": 1,
        {
            "formatcomponentType": "dd/MM/yyyyEditLayout",
              "layoutDefinition": [  },
                {
                    "visiblegridColumns": false12,
                    "componentTypeorder": "TableLayout"1,
                  },  "componentType": "DetailLayout"
                {}
            ],
            "visiblekey": falsetrue,
                    "componentTypeproperty": "EditLayoutemployeeRegistration",
                }"label": "Matrícula",
                {
        "disabled": true,
            "visibletype": false"string",
                    "componentType": "DetailLayoutInput"
        },
        }{
            ]"format": "dd/MM/yyyy",
            "keylayoutDefinition": true,[
            "property": "changeDatePK",
            "label": "Data da Mudança",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
        {
        "layoutDefinition": [
                {
                    "order": 32,
                    "componentType": "TableLayout"
                },
                {
                    "gridColumns": 26,
                    "order": 32,
                    "componentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "order": 32,
                    "componentType": "DetailLayout"
                }
            ],
            "keyproperty": true,
            "property": "salaryNro"changeDate",
            "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,
                    "order": 9,
                    "componentType": "DetailLayout"
                }
            ],
            "propertykey": "processingDate"true,
            "labelproperty": "Data ProcessamentochangeDatePK",
            "label": "Data da 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": "EditLayout"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,
                    "order": 7,
                    "componentType": "EditLayoutcomponentType": "EditLayout"
                },
                {
                    "gridColumns": 4,
                    "visible": false,
                    "order": 75,
                    "componentType": "DetailLayout"
                }
            ],
            "property": "referenceCharsalary",
            "label": "ReferênciaSalário",
            "type": "stringcurrency",
            "componentType": "InputDecimal"
        },
        {
            "quickFilterlayoutDefinition": true,
            "columns": [
                {
                    "fieldLabelorder": false6,
                    "labelcomponentType": "CódigoTableLayout",
                },
    "property": "code"
            {
    },
                {"gridColumns": 2,
                    "fieldLabelorder": false6,
                    "labelcomponentType": "DescriçãoEditLayout",
                    "property": "description"},
                }{
            ],
            "requiredgridColumns": true4,
            "searchService": "/api/rh/v1/readonly/lookups/generic/reasonChange",
            "formatorder": [6,
                    "componentType": "codeDetailLayout",
                "description"}
            ],
            "fieldLabelproperty": "codeeventId",
            "fieldValuelabel": "codeCódigo do evento",
            "layoutDefinitiontype": ["string",
            "componentType": "Input"
    {    },
        {
            "ordermaxLength": 76,
                    "componentTypelayoutDefinition": "TableLayout"
                },[
                {
                    "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": "Input"
        },
  code"
      {
            "columns": [},
                {
                    "fieldLabel": false,
                    "label": "Cód da Tabela SalarialDescrição",
                    "property": "codedescription"
                },
                {
        ],
            "fieldLabelrequired": falsetrue,
                    "labelsearchService": "Tabela/api/rh/v1/readonly/lookups/generic/reasonChange",
                    "propertyformat": "description"[
                }
            ],
            "searchService": "/api/rh/v1/readonly/lookups/generic/salaryHistoryTable",
            "format": ["code",
                "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 SalarialMotivo da Mudança",
            "visiblecomponentType": false,"Lookup"
            "componentType": "Lookup"
        }},
        {
            "columnslayoutDefinition": [
                {
                    "fieldLabelorder": false7,
                    "labelcomponentType": "Código identificador",
                    "property": "codeTableLayout"
                },
                {
                    "fieldLabelvisible": false,
                    "labelcomponentType": "Faixa",
                    "property": "descriptionEditLayout"
                },
                {
                    "fieldLabelvisible": false,
                    "labelcomponentType": "Percentual do Valor de RefrênciaDetailLayout",
                }
    "property": "complementaryField"
        ],
          }  "property": "descriptionReason",
            ]"label": "Desc. Motivo",
            "searchServicetype": "/api/rh/v1/readonly/lookups/generic/salaryRangeHistorystring",
            "formatcomponentType": ["Input"
        },
        "code",{
                "descriptioncolumns": [
              ],
  {
                    "fieldLabel": "code"false,
                    "fieldValuelabel": "codeCód da Tabela Salarial",
                    "layoutDefinitionproperty": ["code"
                {},
                {
                    "visiblefieldLabel": false,
                    "orderlabel": 7"Tabela",
                    "componentTypeproperty": "TableLayoutdescription"
                },
                {
        ],
            "gridColumnssearchService": 6,
        "/api/rh/v1/readonly/lookups/generic/salaryHistoryTable",
            "orderformat": 11,[
                    "componentType"code",: "EditLayout"
                }"description"
            ],
            "cleanfieldLabel": true"code",
            "noAutoCompletefieldValue": true"code",
            "propertylayoutDefinition": "salaryRangeHistory",[
            "label": "Histórico de Faixa",
    {
                    "visible": false,
                    "componentTypeorder": "Lookup"7,
          },
          {
"componentType": "TableLayout"
                "columns": [},
                {
                    "fieldLabelgridColumns": false6,
                    "labelorder": "Código identificador"10,
                    "propertycomponentType": "codeEditLayout"
                },
                {
      ],
              "fieldLabelclean": falsetrue,
                    "labelnoAutoComplete": "Nome do Nível"true,
                    "property": "descriptionsalaryHistoryTable",
                }"label": "Histórico Tabela Salarial",
            ]"visible": false,
            "searchServicecomponentType": "/api/rh/v1/readonly/lookups/generic/salaryLevelHistory",Lookup"
        },
        {
            "formatcolumns": [
                "code",{
                    "descriptionfieldLabel": false,
            ],
            "fieldLabellabel": "codeCódigo identificador",
                    "fieldValueproperty": "code",
              "layoutDefinition": [  },
                {
                    "visiblefieldLabel": false,
                    "orderlabel": 7"Faixa",
                    "componentTypeproperty": "TableLayoutdescription"
                },
                {
                    "gridColumnsfieldLabel": 6false,
                    "orderlabel": 12"Percentual do Valor de Refrência",
                    "componentTypeproperty": "EditLayoutcomplementaryField"
                }
            ],
            "cleansearchService": true"/api/rh/v1/readonly/lookups/generic/salaryRangeHistory",
            "noAutoCompleteformat": true,[
            "property": "salaryLevelHistory    "code",
              "label": "Histórico de Nível",  "description"
            "visible": false],
            "componentTypefieldLabel": "Lookupcode",
        },
        {"fieldValue": "code",
            "layoutDefinition": [
                {
                    "ordervisible": 15false,
                    "order": 7,
                    "componentType": "TableLayout"
                },
                {
                    "disabledgridColumns": true6,
                    "gridColumnsorder": 211,
                    "visiblecomponentType": false,"EditLayout"
                }
    "order": 12,
        ],
            "componentTypeclean": "EditLayout"true,
                }"noAutoComplete": true,
            "property": "salaryRangeHistory",
    {
        "label": "Histórico de Faixa",
            "visible": false,
                    "componentType": "DetailLayoutLookup"
        },
        }{
            ],
"columns": [
                "property": "changeJourney",
{
                    "labelfieldLabel": "Alteração de Jornada"false,
                    "typelabel": "stringCódigo identificador",
                    "componentTypeproperty": "Inputcode"
                },
        {
        {
    "layoutDefinition": [
                {"fieldLabel": false,
                    "orderlabel": 5"Nome do Nível",
                    "componentTypeproperty": "TableLayoutdescription"
                },
                {],
                    "visiblesearchService": false,
        "/api/rh/v1/readonly/lookups/generic/salaryLevelHistory",
            "componentTypeformat": "EditLayout"[
                }"code",
                {"description"
            ],
            "visiblefieldLabel": false"code",
            "fieldValue": "code",
            "componentTypelayoutDefinition": "DetailLayout"[
                }{
            ],
            "propertyvisible": "percentage"false,
                    "labelorder": "% Variação Salarial"7,
                    "typecomponentType": "stringTableLayout",
            "componentType": "Input"
            },
        {
            "decimalsLength": 2,
    {
        "thousandMaxlength": 9999999,
            "layoutDefinitiongridColumns": [
                {6,
                    "order": 612,
                    "componentType": "TableLayoutEditLayout"
                },
            ],
    {
        "clean": true,
            "visiblenoAutoComplete": falsetrue,
            "property": "salaryLevelHistory",
            "componentTypelabel": "EditLayoutHistórico de Nível",
                }"visible": false,
                {"componentType": "Lookup"
                    "visible": false},
        {
            "componentTypelayoutDefinition": "DetailLayout"[
                }{
            ],
            "propertyorder": "salaryHour"15,
                    "labelcomponentType": "Salário HoraTableLayout",
              "type": "currency"  },
            "componentType": "Decimal"
        },{
        {
            "layoutDefinitiondisabled": [true,
                  {  "gridColumns": 2,
                    "ordervisible": 7false,
                    "componentType": "TableLayout"
                },
                {
                    "visible": falseorder": 12,
                    "componentType": "EditLayout"
                },
                {
                    "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": [
                {
                    "visibleorder": false11,
                    "ordercomponentType": 14,
                    "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
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 Retorno

Status Code: 201 Created

  {
            "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],
            "referenceproperty": 0.0"includedDate",
            "journeyCharlabel": "000:00"Data de Inlusão",
            "type": "date",
            "componentType": "DatePicker"
        },

Expandir
titleExemplo de utilização
Expandir
titleEdição de Registro

        {
            "layoutDefinition": [
                {
                    "order": 14,
                    "componentType": "TableLayout"
                },
                {
                    "visible": false,
                    "componentType": "EditLayout"
                },
                {

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

 {
            "companyId": 1,
            "employeeRegistration": "00001",
                    "changeDatevisible": "2011-09-05T00:00:00-03:00"false,
                    "reasoncomponentType": "01DetailLayout",
              "salaryNro": 1,  }
            "salary": 4000],
            "property": "journey": 220,
            "includedDatelabel": "2025-03-02T00:00:00-03:00Jornada",
            "processingDatetype": "2011-09-05T00:00:00-03:00number",
            "changeJourneycomponentType": 0,"Number"
            "percentageApplied": 0.0},
        {
            "layoutDefinition": [
                {
                    "referencevisible": 0.0false,
                    "journeyCharorder": "000:00"
14,
                    "componentType": "TableLayout"
                }

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