SAsankhya
HCM Cadastros

Consultar períodos aquisitivos de férias

Changed on

Retorna os períodos aquisitivos de férias não gozados cadastrados no SankhyaOm. Um período não gozado pode ter saldo de dias igual a zero. Por padrão, esses períodos com saldo zerado também não são retornados; utilize o parâmetro saldoZerado=true para incluí-los.

Regras de filtro:

  • codigoFuncionario só pode ser informado em conjunto com codigoEmpresa.

Versão mínima do módulo pessoal: 5.102.0

get/v1/pessoal/periodos-aquisitivos-ferias

Request

  • Base URL
    https://api.sankhya.com.br
  • URL
    https://api.sankhya.com.br/v1/pessoal/periodos-aquisitivos-ferias
  • Auth
    API key in header Authorization

Query parameters

codigoEmpresainteger
Example:1

Código da empresa. Obrigatório quando codigoFuncionario for informado. Entidade: EmpresaPessoal (TFPFUN.CODEMP).

codigoFuncionariointeger
Example:100

Código do funcionário. Requer que codigoEmpresa também seja informado. Entidade: Funcionário (TFPFUN.CODFUNC).

updatedSincestring
Example:2024-01-01T00:00:00

Filtra registros alterados a partir desta data/hora. Formato: AAAA-MM-DDTHH:MM:SS.

saldoZeradoboolean

Quando true, inclui na resposta períodos não gozados cujo saldo de dias é zero. Por padrão (false), apenas períodos não gozados com saldo maior que zero são retornados.

pageinteger

Número da página para paginação, iniciando em ZERO (0).

Response

Lista de períodos aquisitivos retornada com sucesso.

Example response

{
  "periodosAquisitivos": [
    {
      "empresa": {
        "codigo": 1,
        "nomeFantasia": "Empresa ABC"
      },
      "funcionario": {
        "codigo": 100,
        "nome": "João Silva"
      },
      "periodoAquisitivo": {
        "dataInicio": "01/03/2024 00:00:00",
        "dataFim": "01/03/2025 00:00:00"
      },
      "abonoPecuniario": 10,
      "faltasNoPeriodo": 2,
      "diasPerdidoFaltas": 6,
      "diasFeriasGozados": 10,
      "saldoDias": 14,
      "dataAlteracao": "01/06/2024 10:30:00"
    }
  ]
}

Changes

  • b3c833e7aab1Revision changes
    • breaking

      the response's property type changed from string to object for status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status