Skip to main content
GET
/
banco-horas
/
saldos
/
{colaboradorId}
Busca saldo do banco de horas para um colaborador
curl --request GET \
  --url https://api.example.com/banco-horas/saldos/{colaboradorId}
{
  "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"
      }
    }
  ]
}

Path Parameters

colaboradorId
string
required

Id do colaborador

Example:

"a2f2cbed-e141-465c-a769-f1591be5f35c"

Response

Saldo do banco de horas do colaborador

colaboradorId
string
required

ID do colaborador

Example:

"123-456abc"

nome
string
required

Nome do colaborador

Example:

"João Silva"

numeroDocumento
string
required

CPF ou CNPJ do colaborador

Example:

"15217510056"

unidadeNegocio
string
required

Nome da unidade de negócio do colaborador

Example:

"Pontua"

regraDePonto
string
required

Nome da regra de ponto do colaborador

Example:

"BH Padrão"

saldoAtivo
string
required

Saldo do ciclo vigente do banco de horas

Example:

"+2:37"

saldoCiclosEmAberto
string
required

Saldo total dos ciclos em aberto do banco de horas

Example:

"+7:32"

foto
string

Url para download da foto do colaborador

Example:

"https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"

logoUnidadeNegocio
string

Url para download da foto da unidade de negócio

Example:

"https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"

cicloAtivoId
string

ID do ciclo ativo do banco de horas

Example:

"123-456abc"

dataInicialCicloAtivo
string<date-time>

Data inicial do ciclo ativo do banco de horas

Example:

"2024-01-01T00:00:00.000Z"

dataFinalCicloAtivo
string<date-time>

Data final do ciclo ativo do banco de horas

Example:

"2024-01-31T00:00:00.000Z"

ciclosEmAberto
object[]

Ciclos do banco de horas em aberto