SAsankhya
HCM Funcionários

Lista os funcionários modificados

Changed on

Retorna uma lista de funcionários, com paginação, cadastrados no SankhyaOM. Permite filtrar por situação e/ou empresa.

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

get/v1/pessoal/funcionarios

Request

  • Base URL
    https://api.sankhya.com.br
  • URL
    https://api.sankhya.com.br/v1/pessoal/funcionarios
  • Auth
    API key in header Authorization

Query parameters

pageinteger

Página de resultados a ser exibida (paginação).

modifiedSincestring date-time
Example:2023-01-01T00:00:00

Data hora da ultima modificação. Quando este parametro é enviado, o serviço retorana apenas registros que tiveram modificação deste da data/hora enviada. Vale ressaltar que este recurso é condicionada a utilização do Log de Alterações no SankhyaOm no ambiente do cliente. O formato deve ser o seguinte: AAAA-MM-DDTHH:MM:SS

situacao'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
Example:1

Filtro opcional. Código da situação do funcionário:

  • 0 - Demitido
  • 1 - Atividade normal
  • 2 - Afastado sem remuneração
  • 3 - Afastado por acidente de trabalho
  • 4 - Afastado para serviço militar
  • 5 - Afastado por licença maternidade
  • 6 - Afastado por doença acima de 15 dias
  • 7 - Outros
  • 8 - Transferido
  • 9 - Aposentadoria por invalidez
codigoEmpresainteger
Example:2

Filtro opcional. Código da empresa para filtrar os funcionários.

Response

Lista de funcionários retornada com sucesso

Example response

{
  "codigos": [
    {
      "codigoEmpresa": 1,
      "codigoFuncionario": 1,
      "nome": "Maria da Silva",
      "nomeMae": "Joana da Silva",
      "email": "exemplo@exemplo.com.br",
      "situacao": "1"
    },
    {
      "codigoEmpresa": 2,
      "codigoFuncionario": 2,
      "nome": "Joao Santos",
      "nomeMae": "Maria dos Santos",
      "email": "exemplo@exemplo.com.br",
      "situacao": "0"
    }
  ],
  "pagination": {
    "page": "0",
    "offset": "0",
    "total": "2",
    "hasMore": "false"
  }
}

Changes

  • b3c833e7aab1Revision changes
    • breaking

      the response's body type changed from array to object for status

    • info

      added the non-success 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