Consultar espelho de ponto

GET 
/espelhoPonto

Consolida, por funcionário e dia, marcações, ocorrências, horas extras, feriados, DSR, compensações e eventos da competência. Se as datas forem omitidas, utiliza os limites configurados no período de ponto. Datas informadas precisam pertencer ao período. Os eventos incluídos têm sua data de envio à folha atualizada.

Request

Query Parameters

Responses

200

Espelho consolidado por funcionário.

application/json

Schema

Schema

dados

object[]

required

Array [

codEmpresa string

matricula int64

datas

object[]

Array [

data date

marcacoes

object[]

Array [

turno int32

horaEntrada date-timenullable

horaSaida date-timenullable

]

tipoHorario stringnullable

feriado boolean

dsr booleannullable

compensacao booleannullable

ocorrencias

object[]

Array [

id int64

descricao string

qtdMinutos int64nullable

qtdMinutosNoturno int64nullable

]

horaExtras

object[]

Array [

descr string

descrAbrev string

horaExtraInicial date-timenullable

horaExtraFinal date-timenullable

compensacao boolean

autorizada boolean

]

]

eventos

object[]

Array [

descricao string

conteudo double

]

]

Example (from schema)

{
  "dados": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "codFuncionario": 0,
      "datas": [
        {
          "data": "2024-07-29",
          "marcacoes": [
            {
              "turno": 0,
              "horaEntrada": "2024-07-29T15:51:28.071Z",
              "horaSaida": "2024-07-29T15:51:28.071Z"
            }
          ],
          "tipoHorario": "string",
          "feriado": true,
          "dsr": true,
          "compensacao": true,
          "ocorrencias": [
            {
              "id": 0,
              "descricao": "string",
              "qtdMinutos": 0,
              "qtdMinutosNoturno": 0
            }
          ],
          "horaExtras": [
            {
              "tipoPagamento": "string",
              "descr": "string",
              "descrAbrev": "string",
              "horaExtraInicial": "2024-07-29T15:51:28.071Z",
              "horaExtraFinal": "2024-07-29T15:51:28.071Z",
              "compensacao": true,
              "autorizada": true,
              "qtd": 0
            }
          ]
        }
      ],
      "eventos": [
        {
          "codigo": "string",
          "descricao": "string",
          "unidade": "H",
          "conteudo": 0
        }
      ]
    }
  ]
}

Example

{
  "dados": [
    {
      "codEmpresa": "VNC",
      "matricula": 100,
      "codFuncionario": 9876,
      "datas": [
        {
          "data": "2026-01-05",
          "marcacoes": [
            {
              "turno": 1,
              "horaEntrada": "2026-01-05T08:00:00",
              "horaSaida": "2026-01-05T12:00:00"
            }
          ],
          "tipoHorario": "NORMAL",
          "feriado": false,
          "dsr": false,
          "compensacao": false,
          "ocorrencias": [],
          "horaExtras": [
            {
              "tipoPagamento": "205",
              "descr": "Horas extras 50%",
              "descrAbrev": "HE 50%",
              "horaExtraInicial": "2026-01-05T17:00:00",
              "horaExtraFinal": "2026-01-05T18:00:00",
              "compensacao": false,
              "autorizada": true,
              "qtd": 60
            }
          ]
        }
      ],
      "eventos": [
        {
          "codigo": "101",
          "descricao": "Horas normais",
          "unidade": "H",
          "conteudo": 176
        }
      ]
    }
  ]
}

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