> ## 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 saldos do banco de horas



## OpenAPI

````yaml https://api.pre.pontua.tech/api/public/doc-json get /banco-horas/saldos
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:
  /banco-horas/saldos:
    get:
      tags:
        - Banco de Horas
      summary: Busca saldos do banco de horas
      operationId: BancoHorasController_BuscarSaldos
      parameters:
        - name: searchText
          required: false
          in: query
          description: Texto para filtrar por nome, CPF ou CNPJ
          schema:
            example: João
            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: regraDePontoId
          required: false
          in: query
          description: ID da regra de ponto para filtrar
          schema:
            example: aefd4e82-86ce-4edf-b9e3-7a956bccb6d0
            type: string
        - name: cicloBancoHorasId
          required: false
          in: query
          description: ID do ciclo do banco de horas para filtrar
          schema:
            example: aefd4e82-86ce-4edf-b9e3-7a956bccb6d0
            type: string
        - name: sinalSegmentacao
          required: false
          in: query
          description: Sinal de segmentação para filtrar
          schema:
            default: POSITIVO
            enum:
              - POSITIVO
              - NEGATIVO
            type: string
        - name: comparadorSegmentacao
          required: false
          in: query
          description: Comparador de segmentação para filtrar
          schema:
            default: MAIOR
            enum:
              - MAIOR
              - MENOR
              - IGUAL
            type: string
        - name: valorSaldoAtivoSegmentacao
          required: false
          in: query
          description: Valor do saldo ativo, em horas, de segmentação para filtrar
          schema:
            example: 100
            type: number
      responses:
        '200':
          description: Saldos do banco de horas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuscaSaldosRespostaDto'
        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: []
        - cookie: []
components:
  schemas:
    BuscaSaldosRespostaDto:
      type: object
      properties:
        pagina:
          type: number
          description: Pagina retornada dos dados
          example: 0
        limite:
          type: number
          description: Quantidade de itens retornados na consulta
          example: 10
        total:
          type: number
          description: Total de itens existentes
          example: 100
        unidades:
          description: Resultado da consulta
          type: array
          items:
            $ref: '#/components/schemas/SaldoColaboradorDto'
      required:
        - total
        - unidades
    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
    SaldoColaboradorDto:
      type: object
      properties:
        colaboradorId:
          type: string
          description: ID do colaborador
          example: 123-456abc
        nome:
          type: string
          description: Nome do colaborador
          example: João Silva
        numeroDocumento:
          type: string
          description: CPF ou CNPJ do colaborador
          example: '15217510056'
        foto:
          type: string
          description: Url para download da foto do colaborador
          example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg
        unidadeNegocio:
          type: string
          description: Nome da unidade de negócio do colaborador
          example: Pontua
        logoUnidadeNegocio:
          type: string
          description: Url para download da foto da unidade de negócio
          example: https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg
        regraDePonto:
          type: string
          description: Nome da regra de ponto do colaborador
          example: BH Padrão
        saldoAtivo:
          type: string
          description: Saldo do ciclo vigente do banco de horas
          example: '+2:37'
        cicloAtivoId:
          type: string
          description: ID do ciclo ativo do banco de horas
          example: 123-456abc
        dataInicialCicloAtivo:
          format: date-time
          type: string
          description: Data inicial do ciclo ativo do banco de horas
          example: '2024-01-01T00:00:00.000Z'
        dataFinalCicloAtivo:
          format: date-time
          type: string
          description: Data final do ciclo ativo do banco de horas
          example: '2024-01-31T00:00:00.000Z'
        saldoCiclosEmAberto:
          type: string
          description: Saldo total dos ciclos em aberto do banco de horas
          example: '+7:32'
        ciclosEmAberto:
          description: Ciclos do banco de horas em aberto
          type: array
          items:
            $ref: '#/components/schemas/CicloBancoHorasColaboradorDto'
      required:
        - colaboradorId
        - nome
        - numeroDocumento
        - unidadeNegocio
        - regraDePonto
        - saldoAtivo
        - saldoCiclosEmAberto
    CicloBancoHorasColaboradorDto:
      type: object
      properties:
        cicloId:
          type: string
          description: ID do ciclo do banco de horas
          example: 123-456abc
        colaboradorId:
          type: string
          description: ID do colaborador
          example: 123-456abc
        colaborador:
          type: string
          description: Nome do colaborador
          example: João Silva
        numeroDocumento:
          type: string
          description: CPF ou CNPJ do colaborador
          example: '15217510056'
        unidadeNegocio:
          type: string
          description: Nome da unidade de negócio do ciclo do banco de horas
          example: Pontua
        dataInicial:
          format: date-time
          type: string
          description: Data inicial do ciclo do banco de horas
          example: '2024-01-01T00:00:00.000Z'
        dataFinal:
          format: date-time
          type: string
          description: Data final do ciclo do banco de horas
          example: '2024-01-31T00:00:00.000Z'
        saldoInicial:
          type: string
          description: Saldo inicial do colaborador no ciclo do banco de horas
          example: '+0:37'
        creditos:
          type: string
          description: >-
            Somatório dos saldos positivos do colaborador no ciclo do banco de
            horas
          example: '+5:00'
        debitos:
          type: string
          description: >-
            Somatório dos saldos negativos do colaborador no ciclo do banco de
            horas
          example: '-3:00'
        saldoFinal:
          type: string
          description: >-
            Somatório total do saldo inicial, créditos e débitos do colaborador
            no ciclo do banco de horas
          example: '+2:37'
        saldoOperacao:
          type: string
          description: Saldo da operação, positivo ou negativo, a ser debitado ou creditado
          example: '-2:37'
        saldoDepoisOperacao:
          type: string
          description: Saldo do colaborador no ciclo de banco de horas depois da operação
          example: '0:00'
        transferirParaCiclo:
          description: >-
            Ciclo para o qual o saldo será transferido, para o caso de
            transferência de saldo
          allOf:
            - $ref: '#/components/schemas/CicloBancoHorasDto'
      required:
        - saldoInicial
        - creditos
        - debitos
        - saldoFinal
    CicloBancoHorasDto:
      type: object
      properties:
        cicloBancoHorasId:
          type: string
          description: ID do ciclo do banco de horas
          example: 123-456abc
        dataInicio:
          format: date-time
          type: string
          description: Data de início do ciclo do banco de horas
          example: '2022-01-01T00:00:00.000Z'
        dataFim:
          format: date-time
          type: string
          description: Data do fim do ciclo do banco de horas
          example: '2022-01-31T00:00:00.000Z'
        fechado:
          type: boolean
          description: Indica se o ciclo do banco de horas está fechado
          example: false
        regraDePontoId:
          type: string
          description: ID da regra de ponto do ciclo do banco de horas
          example: 123-456abc
        regraDePonto:
          type: string
          description: Nome da regra de ponto do ciclo do banco de horas
          example: BH Padrão
      required:
        - cicloBancoHorasId
        - dataInicio
        - dataFim
        - fechado
        - regraDePontoId
        - regraDePonto

````