Skip to main content
GET
/
banco-horas
/
saldos
Busca saldos do banco de horas
curl --request GET \
  --url https://api.example.com/banco-horas/saldos
{
  "total": 100,
  "unidades": [
    {
      "colaboradorId": "123-456abc",
      "nome": "João Silva",
      "numeroDocumento": "15217510056",
      "unidadeNegocio": "Pontua",
      "regraDePonto": "BH Padrão",
      "saldoAtivo": "+2:37",
      "saldoCiclosEmAberto": "+7:32",
      "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
      "logoUnidadeNegocio": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
      "cicloAtivoId": "123-456abc",
      "dataInicialCicloAtivo": "2024-01-01T00:00:00.000Z",
      "dataFinalCicloAtivo": "2024-01-31T00:00:00.000Z",
      "ciclosEmAberto": [
        {
          "saldoInicial": "+0:37",
          "creditos": "+5:00",
          "debitos": "-3:00",
          "saldoFinal": "+2:37",
          "cicloId": "123-456abc",
          "colaboradorId": "123-456abc",
          "colaborador": "João Silva",
          "numeroDocumento": "15217510056",
          "unidadeNegocio": "Pontua",
          "dataInicial": "2024-01-01T00:00:00.000Z",
          "dataFinal": "2024-01-31T00:00:00.000Z",
          "saldoOperacao": "-2:37",
          "saldoDepoisOperacao": "0:00",
          "transferirParaCiclo": {
            "cicloBancoHorasId": "123-456abc",
            "dataInicio": "2022-01-01T00:00:00.000Z",
            "dataFim": "2022-01-31T00:00:00.000Z",
            "fechado": false,
            "regraDePontoId": "123-456abc",
            "regraDePonto": "BH Padrão"
          }
        }
      ]
    }
  ],
  "pagina": 0,
  "limite": 10
}

Query Parameters

searchText
string

Texto para filtrar por nome, CPF ou CNPJ

Example:

"João"

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

regraDePontoId
string

ID da regra de ponto para filtrar

Example:

"aefd4e82-86ce-4edf-b9e3-7a956bccb6d0"

cicloBancoHorasId
string

ID do ciclo do banco de horas para filtrar

Example:

"aefd4e82-86ce-4edf-b9e3-7a956bccb6d0"

sinalSegmentacao
enum<string>
default:POSITIVO

Sinal de segmentação para filtrar

Available options:
POSITIVO,
NEGATIVO
comparadorSegmentacao
enum<string>
default:MAIOR

Comparador de segmentação para filtrar

Available options:
MAIOR,
MENOR,
IGUAL
valorSaldoAtivoSegmentacao
number

Valor do saldo ativo, em horas, de segmentação para filtrar

Example:

100

Response

Saldos do banco de horas

total
number
required

Total de itens existentes

Example:

100

unidades
object[]
required

Resultado da consulta

pagina
number

Pagina retornada dos dados

Example:

0

limite
number

Quantidade de itens retornados na consulta

Example:

10