Consultar ocorrências

GET 
/ocorrencia

Retorna lançamentos de ocorrências que terminem na data inicial ou depois dela (incluindo ocorrências sem data final) e que iniciem até a data final, quando informada. Por padrão, retorna somente tipos configurados como "considera dia normal".

Request

Query Parameters

Responses

200

Ocorrências encontradas, agrupadas por empresa e matrícula.

application/json

Schema

Schema

dados

object[]

required

Array [

codEmpresa string

matricula int64

ocorrencias

object[]

Array [

descricao string

consideraDiaNormal boolean

dataInicial date

dataFinal datenullable

horaInicial date-timenullable

horaFinal date-timenullable

observacao stringnullable

usuario stringnullable

dataHoraLancamento date-timenullable

qtdMinutos int64nullable

qtdMinutosNoturno int64nullable

]

]

Example (from schema)

{
  "dados": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "ocorrencias": [
        {
          "id": 0,
          "descricao": "string",
          "consideraDiaNormal": true,
          "dataInicial": "2024-07-29",
          "dataFinal": "2024-07-29",
          "horaInicial": "2024-07-29T15:51:28.071Z",
          "horaFinal": "2024-07-29T15:51:28.071Z",
          "observacao": "string",
          "usuario": "string",
          "dataHoraLancamento": "2024-07-29T15:51:28.071Z",
          "qtdMinutos": 0,
          "qtdMinutosNoturno": 0
        }
      ]
    }
  ]
}

Example

{
  "dados": [
    {
      "codEmpresa": "VNC",
      "matricula": 32,
      "ocorrencias": [
        {
          "id": 2,
          "descricao": "Atestado médico",
          "consideraDiaNormal": true,
          "dataInicial": "2026-06-03",
          "dataFinal": "2026-06-03",
          "horaInicial": "2026-06-03T08:00:00",
          "horaFinal": "2026-06-03T12:00:00",
          "observacao": "Consulta médica",
          "usuario": "ADMIN",
          "dataHoraLancamento": "2026-06-03T13:15:00",
          "qtdMinutos": 240,
          "qtdMinutosNoturno": 0
        }
      ]
    }
  ]
}

400

Parâmetro ausente, inválido ou incompatível com a configuração do período.

application/json

Schema

Schema

errors

object[]

required

Array [

]

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "msg": "string"
    }
  ]
}

obrigatorio

{
  "errors": [
    {
      "id": "dataInicial",
      "msg": "O campo [dataInicial] não pode ser vazio"
    }
  ]
}

periodoNaoConfigurado

{
  "errors": [
    {
      "id": "parametroFolhaPonto",
      "msg": "Não foi encontrado período de folha para a competência informada"
    }
  ]
}

dataForaDoPeriodo

{
  "errors": [
    {
      "id": "dataInicial",
      "msg": "A data informada deve estar compreendida no período de ponto"
    }
  ]
}

403

Token ausente, inválido, expirado ou sem autorização para a operação.

application/json

Schema

Schema

Example (from schema)

{
  "message": "Operação Negada! Entre em contato com o administrador da API."
}

tokenAusente

{
  "message": "É necessário o envio de token para essa operação"
}

tokenExpirado

{
  "message": "Token expirou!"
}

Loading...