Skip to main content
GET
/
banco-horas
/
movimentacoes
/
preparar
Busca saldos de colaboradores para preparar uma movimentação em um ciclo de banco de horas
curl --request GET \
  --url https://api.example.com/banco-horas/movimentacoes/preparar
{
  "tipoMovimentacao": "QUITACAO_INTEGRAL",
  "cicloBancoHorasId": "123-456abc",
  "ciclo": {
    "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"
  },
  "colaboradores": [
    {
      "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"
      }
    }
  ],
  "ocultarColaboradoresSaldoZerado": false,
  "regrasAvancadas": false,
  "fechamentoCiclo": false,
  "limitePositivoMinutos": 120,
  "limiteNegativoMinutos": -120,
  "sinalSegmentacao": "POSITIVO",
  "comparadorSegmentacao": "MAIOR",
  "valorSaldoAtivoSegmentacao": 100,
  "colaboradorIds": "123-456abc,987-654321",
  "unidadeNegocioId": "123-456abc"
}

Query Parameters

tipoMovimentacao
enum<string>
default:QUITACAO_INTEGRAL
required

Tipo de movimentação do banco de horas

Available options:
QUITACAO_INTEGRAL,
QUITACAO_COM_LIMITE,
QUITACAO_INDIVIDUAL,
TRANSFERIR_SALDO,
LANCAR_SALDO
cicloBancoHorasId
string
required

ID do ciclo do banco de horas

Example:

"123-456abc"

ocultarColaboradoresSaldoZerado
boolean

Ocultar colaboradores com saldo zerado

Example:

false

regrasAvancadas
boolean

Mostrar regras avançadas da distribuição para folha de pagamento

Example:

false

fechamentoCiclo
boolean

A movimentação deverá fechar o ciclo

Example:

false

limitePositivoMinutos
number

Saldo positivo para manter na quitação

Example:

120

limiteNegativoMinutos
number

Saldo negativo para manter na quitação

Example:

-120

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

colaboradorIds
string

IDs de colaboradores específicos, separados por vírgula

Example:

"123-456abc,987-654321"

unidadeNegocioId
string

ID da unidade de negócio, para filtrar colaboradores

Example:

"123-456abc"

Response

Dados para gerenciamento do banco de horas

tipoMovimentacao
enum<string>
default:QUITACAO_INTEGRAL
required

Tipo de movimentação do banco de horas

Available options:
QUITACAO_INTEGRAL,
QUITACAO_COM_LIMITE,
QUITACAO_INDIVIDUAL,
TRANSFERIR_SALDO,
LANCAR_SALDO
cicloBancoHorasId
string
required

ID do ciclo do banco de horas

Example:

"123-456abc"

ciclo
object
required

Ciclo do banco de horas

colaboradores
object[]
required

Colaboradores do ciclo do banco de horas

ocultarColaboradoresSaldoZerado
boolean

Ocultar colaboradores com saldo zerado

Example:

false

regrasAvancadas
boolean

Mostrar regras avançadas da distribuição para folha de pagamento

Example:

false

fechamentoCiclo
boolean

A movimentação deverá fechar o ciclo

Example:

false

limitePositivoMinutos
number

Saldo positivo para manter na quitação

Example:

120

limiteNegativoMinutos
number

Saldo negativo para manter na quitação

Example:

-120

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

colaboradorIds
string

IDs de colaboradores específicos, separados por vírgula

Example:

"123-456abc,987-654321"

unidadeNegocioId
string

ID da unidade de negócio, para filtrar colaboradores

Example:

"123-456abc"