Skip to main content
GET
/
regras-de-ponto
/
shutdowns
Busca fechamentos de bancos de horas e horas extras a partir das regras de ponto
curl --request GET \
  --url https://api.example.com/regras-de-ponto/shutdowns
{
  "totalPunchRules": 13,
  "punchRuleQuantity": 13,
  "ctShutdowns": [
    {
      "punchRuleId": "123-456abc",
      "ruleType": "BANCO_DE_HORAS",
      "name": "Regra de ponto 5",
      "daysForShutdown": 180,
      "shutdownDate": "2024-12-31T00:00:00.000Z"
    }
  ],
  "otShutdowns": [
    {
      "punchRuleId": "123-456abc",
      "ruleType": "BANCO_DE_HORAS",
      "name": "Regra de ponto 5",
      "daysForShutdown": 180,
      "shutdownDate": "2024-12-31T00:00:00.000Z"
    }
  ],
  "page": 0,
  "limit": 10
}

Query Parameters

​
searchText
string

Texto pesquisado para filtrar consulta

​
pagina
number

Página que deseja retornar os resultados

Example:

0

​
limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

​
ativo
boolean

Campo para filtrar regra de ponto por seu status

​
tipos
string

Campo para filtrar regras de ponto por uma lista de tipos separados por vírgula

Example:

"HORAS_EXTRAS,BANCO_DE_HORAS,MISTO"

Response

Cards de fechamentos

​
totalPunchRules
number
required

Quantidade total de regras de ponto

Example:

13

​
punchRuleQuantity
number
required

Quantidade total de regras de ponto contempladas pelos fechamentos retornados

Example:

13

​
ctShutdowns
object[]
required

Fechamentos de bancos de horas

​
otShutdowns
object[]
required

Fechamentos de horas extras

​
page
number

Número da página retornada

Example:

0

​
limit
number

Número de registros por pagina

Example:

10