> ## Documentation Index
> Fetch the complete documentation index at: https://developers.pontua.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Busca fechamentos de bancos de horas e horas extras a partir das regras de ponto



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /regras-de-ponto/shutdowns
openapi: 3.0.0
info:
  title: Pontua Public API
  description: >-
    API oficial da Pontua para integrações de clientes externos. Autentique com
    o token gerado no dashboard em **Configurações → API**. Envie o token no
    header `Authorization: Bearer <SEU_TOKEN>`.
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /regras-de-ponto/shutdowns:
    get:
      tags:
        - Regras de ponto
      summary: >-
        Busca fechamentos de bancos de horas e horas extras a partir das regras
        de ponto
      operationId: RegrasDePontoController_GetShutdowns
      parameters:
        - name: searchText
          description: Texto pesquisado para filtrar consulta
          required: false
          in: query
          schema:
            type: string
        - name: pagina
          description: Página que deseja retornar os resultados
          required: false
          in: query
          schema:
            example: 0
            type: number
        - name: limite
          description: Quantidade de itens que retorna na consulta. Min 1 - Max 100
          required: false
          in: query
          schema:
            example: 100
            type: number
        - name: ativo
          required: false
          in: query
          description: Campo para filtrar regra de ponto por seu status
          schema:
            type: boolean
        - name: tipos
          required: false
          in: query
          description: >-
            Campo para filtrar regras de ponto por uma lista de tipos separados
            por vírgula
          schema:
            example: HORAS_EXTRAS,BANCO_DE_HORAS,MISTO
            type: string
      responses:
        '200':
          description: Cards de fechamentos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PunchRuleShutdownsDto'
        default:
          description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      deprecated: false
      security:
        - bearer: []
components:
  schemas:
    PunchRuleShutdownsDto:
      type: object
      properties:
        page:
          type: number
          description: Número da página retornada
          example: 0
        limit:
          type: number
          description: Número de registros por pagina
          example: 10
        totalPunchRules:
          type: number
          description: Quantidade total de regras de ponto
          example: 13
        punchRuleQuantity:
          type: number
          description: >-
            Quantidade total de regras de ponto contempladas pelos fechamentos
            retornados
          example: 13
        ctShutdowns:
          description: Fechamentos de bancos de horas
          type: array
          items:
            $ref: '#/components/schemas/CTPunchRuleShutdownDto'
        otShutdowns:
          description: Fechamentos de horas extras
          type: array
          items:
            $ref: '#/components/schemas/CTPunchRuleShutdownDto'
      required:
        - totalPunchRules
        - punchRuleQuantity
        - ctShutdowns
        - otShutdowns
    ErrorDto:
      type: object
      properties:
        service:
          type: string
          description: Rota solicitada
        method:
          type: string
          description: Método http
        message:
          description: Mensagem do erro
          oneOf:
            - type: string
              example: message erro
            - type: array
              items:
                type: string
                example:
                  - erro 1
                  - erro 2
      required:
        - service
        - method
        - message
    CTPunchRuleShutdownDto:
      type: object
      properties:
        punchRuleId:
          type: string
          description: ID da regra de ponto
          example: 123-456abc
        ruleType:
          type: string
          description: Tipo da regra de ponto
          enum:
            - HORAS_EXTRAS
            - BANCO_DE_HORAS
            - MISTO
          default: BANCO_DE_HORAS
        name:
          type: string
          description: Nome da regra de ponto
          example: Regra de ponto 5
        daysForShutdown:
          type: number
          description: >-
            Quantos dias faltam para o fechamento do banco de horas ou das horas
            extras
          example: 180
        shutdownDate:
          format: date-time
          type: string
          description: Data do fechamento do banco de horas
          example: '2024-12-31T00:00:00.000Z'
      required:
        - punchRuleId
        - ruleType
        - name
        - daysForShutdown
        - shutdownDate

````