Consultar marcações

GET 
/marcacao

Retorna as marcações do período de folha. Se dataInicial e dataFinal forem omitidas, utiliza os limites configurados no período de ponto da empresa. Datas informadas precisam pertencer a esse período.

Request

Query Parameters

Responses

200

Marcações encontradas, agrupadas por empresa, matrícula e data.

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

]

]

]

Example (from schema)

{
  "dados": [
    {
      "codEmpresa": "string",
      "matricula": 0,
      "datas": [
        {
          "data": "2024-07-29",
          "marcacoes": [
            {
              "turno": 0,
              "horaEntrada": "2024-07-29T15:51:28.071Z",
              "horaSaida": "2024-07-29T15:51:28.071Z"
            }
          ]
        }
      ]
    }
  ]
}

Example

{
  "dados": [
    {
      "codEmpresa": "VNC",
      "matricula": 100,
      "datas": [
        {
          "data": "2026-01-05",
          "marcacoes": [
            {
              "turno": 1,
              "horaEntrada": "2026-01-05T08:00:00",
              "horaSaida": "2026-01-05T12:00:00"
            },
            {
              "turno": 2,
              "horaEntrada": "2026-01-05T13:00:00",
              "horaSaida": "2026-01-05T17:00:00"
            }
          ]
        }
      ]
    }
  ]
}

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