Consultar eventos por competência

GET 
/evento

Retorna os eventos calculados para uma competência. Os registros retornados têm sua data de envio à folha atualizada. Use somenteNaoEnviados=true para buscar apenas registros ainda não marcados como enviados.

Request

Query Parameters

Responses

200

Eventos encontrados, agrupados por empresa, matrícula e data de liberação.

application/json

Schema

Schema

dados

object[]

required

Array [

codEmpresa string

matricula int64

dataLiberacao datenullable

eventos

object[]

Array [

descricao string

conteudo double

]

]

Example (from schema)

{
  "dados": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "dataLiberacao": "2024-07-29",
      "eventos": [
        {
          "codigo": "string",
          "descricao": "string",
          "unidade": "H",
          "conteudo": 0
        }
      ]
    }
  ]
}

Example

{
  "dados": [
    {
      "codEmpresa": "VNC",
      "matricula": 100,
      "dataLiberacao": "2026-03-31",
      "eventos": [
        {
          "codigo": "101",
          "descricao": "Horas normais",
          "unidade": "H",
          "conteudo": 176
        },
        {
          "codigo": "205",
          "descricao": "Horas extras 50%",
          "unidade": "H",
          "conteudo": 8.5
        }
      ]
    }
  ]
}

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...