Páginas filhas
  • API - Documentação Técnica - Histórico de Provisão

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 Folha de Pagamento das linhas RM, Datasul e Protheus, que será utilizada na nova tela "Histórico de Provisão", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Histórico de Provisões que já conheciamos anteriormente.
Este módulo contém dados relativos às provisões mensais de Férias e 13º salário.

Este documento contém detalhes técnicos sobre os parâmetros, os retornos de cada um e a funcionalidade da API.


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

Expandir
titleSchema

Endpoint:  /api/rh/v1/HistoricoProvisao/Schema
Tipo de Requisição: GET
Objetivo: Retornar o Schema utilizado neste endpoint, com propriedades e tipos de dados

Expandir
titleExemplo de Retorno

{
    "title":"Histórico de Provisão",
    "version":"1.0",
    "identifier":"ProvisionHistory",
    "fields":[
        {
            "layoutDefinition":[
                {
                    "visible":false,
                    "componentType":"TableLayout"
                },
                {
                    "visible":false,
                    "componentType":"EditLayout"
                },
                {
                    "visible":false,
                    "componentType":"DetailLayout"
                }
            ],
            "key":true,
            "property":"codigoColigada",
            "label":"Coligada",
            "disabled":true,
            "type":"string",
            "componentType":"Input"
        },
        {
            "quickFilter":true,
            "layoutDefinition":[
                {
                    "order":1,
                    "componentType":"TableLayout"
                },
                {
                    "gridColumns":2,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":2,
                    "componentType":"DetailLayout"
                }
            ],
            "key":true,
            "property":"ano",
            "label":"Ano",
            "type":"string",
            "componentType":"Input"
        },
        {
            "quickFilter":true,
            "options":[
                {
                    "value":1,
                    "label":"Janeiro"
                },
                {
                    "value":2,
                    "label":"Fevereiro"
                },
                {
                    "value":3,
                    "label":"Março"
                },
                {
                    "value":4,
                    "label":"Abril"
                },
                {
                    "value":5,
                    "label":"Maio"
                },
                {
                    "value":6,
                    "label":"Junho"
                },
                {
                    "value":7,
                    "label":"Julho"
                },
                {
                    "value":8,
                    "label":"Agosto"
                },
                {
                    "value":9,
                    "label":"Setembro"
                },
                {
                    "value":10,
                    "label":"Outubro"
                },
                {
                    "value":11,
                    "label":"Novembro"
                },
                {
                    "value":12,
                    "label":"Dezembro"
                }
            ],
            "layoutDefinition":[
                {
                    "widthColumnTable":60,
                    "componentType":"TableLayout"
                },
                {
                    "gridColumns":2,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":2,
                    "componentType":"DetailLayout"
                }
            ],
            "forceOptionsComponentType":"select",
            "key":true,
            "property":"mes",
            "label":"Mês",
            "componentType":"Select"
        },
        {
            "quickFilter":true,
            "columns":[
                {
                    "fieldLabel":false,
                    "label":"Chapa",
                    "property":"chapa"
                },
                {
                    "fieldLabel":false,
                    "label":"Nome",
                    "property":"nome"
                }
            ],
            "required":true,
            "searchService":"/api/rh/v1/chapa",
            "format":[
                "chapa",
                "nome"
            ],
            "fieldLabel":"nome",
            "fieldValue":"chapa",
            "layoutDefinition":[
                {
                    "gridColumns":8,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":8,
                    "componentType":"DetailLayout"
                }
            ],
            "clean":true,
            "noAutoComplete":true,
            "key":true,
            "property":"chapa",
            "label":"Funcionário",
            "componentType":"Lookup"
        },
        {
            "format":"dd/MM/yyyy",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "divider":"Provisão de Férias",
                    "componentType":"EditLayout"
                },
                {
                    "widthColumnTable":120,
                    "componentType":"TableLayout"
                },
                {
                    "gridColumns":4,
                    "divider":"Provisão de Férias",
                    "componentType":"DetailLayout"
                }
            ],
            "property":"dataVencimentoFerias",
            "label":"Data de vencimento férias",
            "type":"date",
            "componentType":"DatePicker"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "locale":"pt-BR",
            "property":"valorPagoFeriasMes",
            "label":"Valor pago Férias Mês",
            "type":"currency",
            "componentType":"Decimal"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "property":"valorProvisaoFeriasEmDobro",
            "label":"Valor provisão férias em Dobro",
            "type":"currency",
            "componentType":"Decimal"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "property":"avosFeriasVencidos",
            "label":"Avos férias vencidos",
            "type":"currency",
            "componentType":"Decimal"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "property":"mediasFeriasVencidas",
            "label":"Médias férias vencidas",
            "type":"currency",
            "componentType":"Decimal"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "property":"valorProvisaoFeriasVencidas",
            "label":"Valor provisão férias vencidas",
            "type":"currency",
            "componentType":"Decimal"
        },
        {
            "decimalsLength":2,
            "thousandMaxlength":6,
            "minValue":"0.00",
            "layoutDefinition":[
                {
                    "gridColumns":4,
                    "componentType":"EditLayout"
                },
                {
                    "gridColumns":4,
                    "componentType":"DetailLayout"
                },
                {
                    "componentType":"TableLayout"
                }
            ],
            "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":[]
}


Expandir
titleInclusão de Registro


...