Histórico da Página

...

Expandir

title	Schema

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

Expandir

title	Exemplo de Retorno

{
"title": "Histórico de EncargosEncargo",
"version": "1.0",
"identifier": "ProvisionHistoryHistoricoEncargo",
"fields": [
{
"layoutDefinition": [
{
"visible": false,
"componentType": "TableLayout"
},
{
"visible": false,
"componentType": "EditLayout"
},
{
"visible": false,
"componentType": "DetailLayout"
}
],
"key": true,
"property": "codigoColigadacodColigada",
"label": "Coligada",
"disabled": true,
"visible": false,
"type": "string",
"componentType": "Input"
},
{
"quickFilter": true,
"layoutDefinitioncolumns": [
{
"fieldLabel": false,
"orderlabel": 1"Chapa",
"componentTypeproperty": "TableLayoutchapa"
},
{
"gridColumnsfieldLabel": 2false,
"componentTypelabel": "EditLayoutNome",
}, "property": "nome"
{}
],
"gridColumnsrequired": 2true,
"componentType":"DetailLayout""searchService": "/api/rh/v1/chapa",
"format": [
}
]"chapa",
"keynome":true,
"property":"ano"],
"labelfieldLabel": "Anonome",
"typefieldValue": "stringchapa",
"componentTypelayoutDefinition": "Input"[
},
{
"quickFiltergridColumns": true5,
"optionscomponentType": ["EditLayout"
{},
"value":1,{
"labelgridColumns": "Janeiro"3,
},
{
"valuevisible": 2false,
"labelcomponentType": "FevereiroDetailLayout"
},
{
"valueorder": 31,
"labelcomponentType": "MarçoFilterLayout"
},
],
{
"clean": true,
"valuenoAutoComplete": 4true,
"key": true,
"labelproperty": "Abrilchapa",
"label": "Matrícula",
"componentType": "Lookup"
},
{
"layoutDefinition": [
{
"valuevisible": 5false,
"labelcomponentType": "MaioEditLayout"
},
{
"valuecomponentType": 6,
"label":"Junho"TableLayout"
},
{
"valuegridColumns": 75,
"labelcomponentType": "JulhoDetailLayout"
},
],{
"valueproperty": 8"nome",
"label": "AgostoNome da pessoa colaboradora",
}"disabled": true,
"type": "string",{
"componentType": "Input"
"value":9},
{
"labelquickFilter": "Setembro"true,
"columns": [},
{
"valuefieldLabel": 10false,
"label": "OutubroCódigo",
"property": "codigo"
},
{
"valuefieldLabel": 11false,
"label": "NovembroDescrição",
},"property": "descricao"
{}
],
"valuerequired": 12true,
"labelsearchService": "Dezembro"/api/rh/v1/encargo",
"format": [
}
]"codigo",
"layoutDefinitiondescricao":[
],{
"widthColumnTablefieldLabel": 60"descricao",
"componentTypefieldValue": "TableLayoutcodigo",
"layoutDefinition": [},
{
"gridColumns": 25,
"componentType": "EditLayout"
},
{
"gridColumns": 3,
"visible": 2false,
"componentType": "DetailLayout"
},
], {
"forceOptionsComponentTypecomponentType": "selectTableLayout",
"key":true },
"property":"mes",{
"labelorder": "Mês"1,
"componentType": "SelectFilterLayout"
},
{ ],
"quickFilterclean": true,
"columnsnoAutoComplete": [true,
"key": true,{
"fieldLabelproperty": false"codEncargo",
"label": "ChapaCódigo do Encargo",
"propertycomponentType": "chapaLookup"
},
{
"layoutDefinition": [
"fieldLabel":false, {
"labelvisible": "Nome"false,
"propertycomponentType": "nomeEditLayout"
},
],
{
"required":true,
"searchServiceorder": "/api/rh/v1/chapa"3,
"format":[
"chapa","componentType": "DetailLayout"
"nome"}
],
"fieldLabelproperty": "nomedescricao",
"fieldValuelabel": "chapaDescrição",
"layoutDefinitiondisabled": [true,
"type": "string",{
"componentType": "Input"
"gridColumns":8},
{
"componentTypequickFilter": "EditLayout"true,
"layoutDefinition": [},
{
"gridColumnsorder": 81,
"componentType": "DetailLayoutTableLayout"
},
],
{
"clean":true,
"noAutoCompletegridColumns": true1,
"keycomponentType": true,"EditLayout"
"property":"chapa" },
"label":"Funcionário", {
"componentType":"Lookup"
}"gridColumns": 1,
{
"formatcomponentType": "dd/MM/yyyyDetailLayout",
"layoutDefinition":[
}
{],
"gridColumnskey": 4true,
"dividerproperty": "Provisão de FériasanoComp",
"componentTypelabel": "EditLayoutAno",
"type": "string",
"componentType": "Input"
},
{
"quickFilter": true,
"options": [
{
"widthColumnTablevalue": 1201,
"componentTypelabel": "TableLayoutJaneiro"
},
{
"gridColumnsvalue": 42,
"dividerlabel": "Provisão de FériasFevereiro",
},
"componentType":"DetailLayout"
{}
],
"propertyvalue": "dataVencimentoFerias"3,
"label": "Data de vencimento fériasMarço",
"type":"date" },
"componentType":"DatePicker"
{},
{
"decimalsLengthvalue": 24,
"thousandMaxlength":6,
"minValuelabel": "0.00Abril",
"layoutDefinition":[ },
{
"gridColumnsvalue": 45,
"componentTypelabel": "EditLayoutMaio"
},
{
"gridColumnsvalue": 46,
"componentTypelabel": "DetailLayoutJunho"
},
{
"componentTypevalue": "TableLayout"7,
} "label": "Julho"
] },
"locale":"pt-BR",
{
"property":"valorPagoFeriasMes",
"labelvalue": "Valor pago Férias Mês"8,
"typelabel": "currencyAgosto",
"componentType":"Decimal" },
},
{
"decimalsLengthvalue": 29,
"thousandMaxlength":6,
"minValuelabel": "0.00Setembro",
"layoutDefinition":[ },
{
"gridColumnsvalue": 410,
"componentTypelabel": "EditLayoutOutubro"
},
{
"gridColumnsvalue": 411,
"componentTypelabel": "DetailLayoutNovembro"
},
{
"componentTypevalue": "TableLayout"12,
}
"label": "Dezembro"
],
"property":"valorProvisaoFeriasEmDobro",}
"label":"Valor provisão férias em Dobro"],
"typelayoutDefinition": "currency",
[
"componentType":"Decimal"
},{
{
"decimalsLengthwidthColumnTable": 260,
"thousandMaxlength":6,
"minValuecomponentType": "0.00TableLayout",
"layoutDefinition":[},
{
"gridColumns": 41,
"componentType": "EditLayout"
},
{
"gridColumns": 41,
"componentType": "DetailLayout"
},
],
{
"componentTypeforceOptionsComponentType": "TableLayout"
}
]select",
"propertykey": "avosFeriasVencidos"true,
"labelproperty": "Avos férias vencidosmesComp",
"typelabel": "currencyMês",
"componentType": "DecimalSelect"
},
{
"decimalsLength": 2,
"thousandMaxlength": 6,
"minValue": "0.00",
"layoutDefinition": [
{
"gridColumns": 46,
"componentType": "EditLayout"
},
{
"gridColumns": 46,
"componentType": "DetailLayout"
},
{
"componentType": "TableLayout"
}
],
"locale": "pt-BR",
"property": "mediasFeriasVencidasbaseEncargo",
"label": "Médias férias vencidasBase do Encargo",
"type": "currency",
"componentType": "Decimal"
},
{
"decimalsLength": 2,
"thousandMaxlength": 6,
"minValue": "0.00",
"layoutDefinition": [
{
"gridColumns": 46,
"componentType": "EditLayout"
},
{
"gridColumns": 46,
"componentType": "DetailLayout"
},
{
"componentType": "TableLayout"
}
],
"propertylocale": "valorProvisaoFeriasVencidaspt-BR",
"labelproperty": "Valor provisão férias vencidasvalor",
"typelabel": "currencyValor Nominal",
"componentTypetype": "Decimal"currency",
},
{
"decimalsLengthcomponentType": 2,"Decimal"
"thousandMaxlength":6},
"minValue":"0.00",{
"layoutDefinition": [
{
"gridColumnsvisible": 4false,
"componentType": "EditLayoutTableLayout"
},
],
{
"property": "aplicacao",
"gridColumnslabel": 4"Aplicacao",
"componentTypedisabled": "DetailLayout"true,
}"visible": false,
{
"type": "string",
"componentType": "TableLayoutInput"
}
],
"property":"avosFeriasProporcionais",
"label":"Avos férias proporcionais",
"type":"decimal",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"mediasFeriasProporcionais",
"label":"Médias férias proporcionais",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"valorProvisaoFeriasProporcionais",
"label":"Valor provisão férias proporcionais",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"valorAbatimentoFerias",
"label":"Valor abatimento férias",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"valorSemAbatimentoFerias",
"label":"Valor sem abatimento férias",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"valorProvisaoFerias",
"label":"Valor provisão férias",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"divider":"Provisão de 13º Salário",
"componentType":"EditLayout"
},
{
"gridColumns":4,
"divider":"Provisão de 13º Salário",
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"avos13",
"label":"Avos 13º",
"type":"decimal",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"medias13Salario",
"label":"Médias 13º salário",
"type":"currency",
"componentType":"Decimal"
},
{
"decimalsLength":2,
"thousandMaxlength":6,
"minValue":"0.00",
"layoutDefinition":[
{
"gridColumns":4,
"componentType":"EditLayout"
},
{
"gridColumns":4,
"componentType":"DetailLayout"
},
{
"componentType":"TableLayout"
}
],
"property":"valorProvisao13",
"label":"Valor provisão 13º",
"type":"currency",
"componentType":"Decimal"
}
],
"groups":[]
}groups": []
}

Expandir

title	Inclusão de Registro

Endpoint: //api/rh/v1/HistoricoEncargo/
Método: POST
Objetivo: Incluir registros no Histórico da Encargos de maneira manual, não necessitando do processo de geração de Histórico de Encargos.

Expandir

title	Exemplo de requisição

{
"chapa": "00002",
"codEncargo": "015",
"anoComp": "2026",
"mesComp": 3,
"baseEncargo": 200,
"valor": 250
}

Expandir

title	Exemplo de Retorno

Status Code: 201 Created

Expandir

title	Inclusão de Registro

Endpoint: /api/rh/v1/HistoricoProvisao/
Método: POST
Objetivo: Incluir registros no Histórico da provisão de maneira manual, não necessitando do processo de geração de Histórico de Encargos.

Expandir

title	Exemplo de requisição

{
"codigoColigada": 1,
"ano": 2024,
"mes": 7,
"chapa": "F0002",
"dataVencimentoFerias": "2025-02-01T00:00:00-03:00",
"valorPagoFeriasMes": 0,
"valorProvisaoFeriasEmDobro": 210.46,
"avosFeriasVencidos": 24,
"mediasFeriasVencidas": 150,
"valorProvisaoFeriasVencidas": 960,
"avosFeriasProporcionais": 9.85,
"mediasFeriasProporcionais": 0,
"valorProvisaoFeriasProporcionais": 110.23,
"valorAbatimentoFerias": 1083.8,
"valorSemAbatimentoFerias": 1083.8,
"valorProvisaoFerias": 4400.97,
"avos13": 9.9,
"medias13Salario": 15.96,
"valorProvisao13": 792
}

Expandir

title	Exemplo de Retorno

Status Code: 201 Created
{
"codigoColigada":1,
"ano":2024,
"mes":7,
"chapa":"F0002",
"dataVencimentoFerias":"2025-02-01T00:00:00-03:00",
"valorPagoFeriasMes":0.0,
"valorProvisaoFeriasEmDobro":210.46,
"avosFeriasVencidos":24.0,
"mediasFeriasVencidas":150.0,
"valorProvisaoFeriasVencidas":960.0,
"avosFeriasProporcionais":9.85,
"mediasFeriasProporcionais":0.0,
"valorProvisaoFeriasProporcionais":110.23,
"valorAbatimentoFerias":1083.8,
"valorSemAbatimentoFerias":1083.8,
"valorProvisaoFerias":4400.97,
"avos13":9.9,
"medias13Salario":15.96,
"valorProvisao13":792.0{
"codColigada": 1,
"chapa": "00002",
"codEncargo": "015",
"anoComp": 2026,
"mesComp": 3,
"baseEncargo": 200.0,
"valor": 250.0,
"aplicacao": "P"
}

Expandir

title	Exemplo de utilização

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

View file

name	HistoricoProvisaoHistoricoEncargo API.postman_collection.json
height	150

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

name	mock_historicodados_dissidio_provisaodelete.json
height	150

Expandir

title	Edição de Registro

Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C CHAPAHistoricoEncargo/1%7CA0004%7C015%7C2011%7C10 ( 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 / CHAPA / CODENCARGO / ANOCOMP / MESCOMP / CHAPA )
Exemplo de requisição com Endpoint montado:
/api/rh/v1/HistoricoProvisao/1%7C1998%7C2%7C00004
MESCOMP )

Método: PUT

Objetivo: Alterar um registro já incluido anteriormente

Expandir

title	Exemplo de requisição

{
"codigoColigadacodColigada": 1,
"ano": 1998,
"mes": 2,
"chapa": "00003A0004",
"dataVencimentoFeriasnome": "1997-08-14T00:00:00-03:00FL LANÇAMENTO FINANCEIRO PROXIMO MÊS FUNCIONÁRIO AFASTADO TIPO T",
"valorPagoFeriasMescodEncargo": 0"015",
"valorProvisaoFeriasEmDobrodescricao": 15"FGTS AFASTAMENTO DO TIPO T",
"avosFeriasVencidosanoComp": 122011,
"mediasFeriasVencidasmesComp": 20010,
"valorProvisaoFeriasVencidasbaseEncargo": 01102,
"avosFeriasProporcionaisvalor": 688.4,
"mediasFeriasProporcionaisaplicacao": 0"P",
"valorProvisaoFeriasProporcionaislinks": 0,
[
{
"valorAbatimentoFeriasrelation": 4400.97"RateioEncargosCC",
"valorSemAbatimentoFeriasapiMetaData": 4400.97"api/rh/v1/RateioEncargoCC/schema",
"valorProvisaoFeriasapiData": 4400.97"api/rh/v1/RateioEncargoCC/",
"avos13": 2apiDataFilter": "?$filter=codColigada eq 1 and chapa eq 'A0004' and anoComp eq 2011 and mesComp eq 10 and codEncargo eq '015'",
"medias13Salariotype": 0"RelatedItems",
"valorProvisao13": 323.18
}

Expandir

title	Exemplo de Retorno

Status Code: 200 OK
label": "Rateio de Encargo por Centro de Custo",
"mapper": {
"codigoColigadaanoComp": 1"2011",
"anomesComp": 1998"10",
"mescodColigada": 2"1",
"chapacodEncargo": "00003015",
"dataVencimentoFeriaschapa": "1997-08-14T00:00:00-03:00"A0004"
}
}
]
}

Expandir

title	Exemplo de Retorno

Status Code: 200 OK

{,
"valorPagoFeriasMes":0.0,
"valorProvisaoFeriasEmDobrocodColigada": 15.01,
"avosFeriasVencidoschapa": 12.0,
"mediasFeriasVencidas":200.0"A0004",
"valorProvisaoFeriasVencidasnome": 0.0,
"avosFeriasProporcionais":6.0"FL LANÇAMENTO FINANCEIRO PROXIMO MÊS FUNCIONÁRIO AFASTADO TIPO T",
"mediasFeriasProporcionaiscodEncargo": 0.0,
"valorProvisaoFeriasProporcionais":0.0"015",
"valorAbatimentoFeriasdescricao": 4400.97"FGTS AFASTAMENTO DO TIPO T",
"valorSemAbatimentoFeriasanoComp": 4400.972011,
"valorProvisaoFeriasmesComp": 4400.9710,
"avos13baseEncargo": 21102.0,
"medias13Salariovalor": 088.04,
"valorProvisao13aplicacao": 323.18"P"
}

Expandir

title	Exemplo de utilização

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

View file

name	HistoricoProvisaoUpdateHistoricoEncargo Update.postman_collection.json
height	150

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

name	mock_historico_provisaoencargos_updateput.json
height	150

Expandir

title	Exclusão de Registro

Endpoint: /api/rh/v1/HistoricoProvisao/CODCOLIGADA %7C ANOCOMP %7C MESCOMP %7C CHAPAHistoricoEncargo/1%7CT0001%7C003%7C2011%7C9 ( 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 / CHAPA / CODENCARGO / ANOCOMP / MESCOMP / CHAPA )
Exemplo de requisição com Endpoint montado:
/api/rh/v1/HistoricoProvisao/1%7C1998%7C2%7C00004
MESCOMP )

Método: DELETE

Objetivo: Excluir um registro já incluido anteriormente

Expandir

title	Exemplo de Retorno

Status Code: 204 No Content

Expandir

title	Exemplo de utilização

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

View file

name	HistoricoProvisaoDeleteHistoricoEncargo Delete.postman_collection.json
height	150

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

name	mock_historico_provisaoencargos_delete.json
height	150

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave