Skip to main content
GET
/
fechamentos
Lista todos os fechamentos
curl --request GET \
  --url https://api.example.com/fechamentos
[
  {
    "fechamentoId": "123456789",
    "codigo": 123,
    "tipo": "PARCIAL",
    "status": "EM_ANDAMENTO",
    "dataInicio": "2024-05-01T00:00:00.000Z",
    "dataFim": "2024-05-31T00:00:00.000Z",
    "tipoRegraDePonto": "BANCO_DE_HORAS",
    "colaboradores": [
      {
        "colaboradorId": "123-456abc",
        "colaborador": "João Silva",
        "numeroDocumento": "15217510056",
        "cargaHoraria": "8:48",
        "horasTrabalhadas": "8:00",
        "creditos": "2:37",
        "debitos": "7:23",
        "saldo": "-4:46",
        "adicionalNoturno": "4:00",
        "bancoHorasPeriodo": "+0:48",
        "bancoHorasTotal": "+0:48",
        "faltas": 2.5,
        "faltasHoras": "7:23",
        "pendencia": false,
        "possuiFechamentoDuplicado": false,
        "saldosPercentuais": [
          {
            "percentual": "0.5",
            "horasReferencia": "+1:30",
            "saldoHoras": 1.5,
            "saldo": "+2:30",
            "bancoHoras": false,
            "horasExtras": true,
            "configPadrao": false,
            "configPersonalizada": false,
            "configAvancada": true
          }
        ]
      }
    ],
    "numeroColaboradores": 237,
    "responsavel": "João Silva",
    "gerarFolhaDePonto": false,
    "enviarFolhaDePonto": false,
    "unidadeNegocio": "Pontua",
    "cadastroUnidadeNegocio": "94522114000145",
    "paginaColaboradores": 0,
    "limiteColaboradores": 10,
    "cicloBancoHoras": {
      "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"
    },
    "departamento": "Técnico",
    "equipe": "Desenvolvedores",
    "turno": "Manhã",
    "tipoTurno": "turnoFixo"
  }
]

Query Parameters

​
dataInicio
string<date-time>
required

Início do período

Example:

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

​
dataFim
string<date-time>
required

Fim do período

Example:

"2024-05-31T23:59:59.999Z"

​
unidadeNegocioId
string

ID da unidade de negócio

Example:

"123-456abc"

​
regraDePontoId
string

ID da regra de ponto

Example:

"123-456abc"

​
departamentoId
string

ID do departamento dos colaboradores para filtrar

Example:

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

​
equipeId
string

ID da equipe dos colaboradores para filtrar

Example:

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

​
turnoId
string

ID do turno dos colaboradores para filtrar

Example:

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

​
centroCustoId
string

ID do centro de custo dos colaboradores para filtrar

Example:

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

Response

Lista de fechamentos

​
fechamentoId
string
required

ID do fechamento

Example:

"123456789"

​
codigo
number
required

Código do fechamento

Example:

123

​
tipo
enum<string>
default:PARCIAL
required

Tipo do fechamento

Available options:
INTEGRAL,
PARCIAL
​
status
enum<string>
default:EM_ANDAMENTO
required

Status do fechamento

Available options:
RASCUNHO,
EM_ANDAMENTO,
CONCLUIDO,
CANCELADO
​
dataInicio
string<date-time>
required

Data de início do fechamento

Example:

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

​
dataFim
string<date-time>
required

Data de fim do fechamento

Example:

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

​
tipoRegraDePonto
enum<string>
default:BANCO_DE_HORAS
required

Tipo de regra de ponto

Available options:
HORAS_EXTRAS,
BANCO_DE_HORAS,
MISTO
​
colaboradores
object[]
required

Colaboradores no fechamento

​
numeroColaboradores
number
required

Número total de colaboradores do fechamento (pode ser usado para paginação)

Example:

237

​
responsavel
string
required

Nome do responsável pelo fechamento

Example:

"João Silva"

​
gerarFolhaDePonto
boolean
default:false

Gerar folha de ponto

​
enviarFolhaDePonto
boolean
default:false

Enviar folha de ponto

​
unidadeNegocio
string

Unidade de negócio do fechamento

Example:

"Pontua"

​
cadastroUnidadeNegocio
string

Número de cadastro da unidade de negócio

Example:

"94522114000145"

​
paginaColaboradores
number

Página para paginação de colaboradores do fechamento

Example:

0

​
limiteColaboradores
number

Limite para paginação de colaboradores do fechamento

Example:

10

​
cicloBancoHoras
object

Ciclo de banco de horas do fechamento

​
departamento
string

Nome do departamento dos colaboradores do fechamento

Example:

"Técnico"

​
equipe
string

Nome da equipe dos colaboradores do fechamento

Example:

"Desenvolvedores"

​
turno
string

Nome do turno dos colaboradores do fechamento

Example:

"Manhã"

​
tipoTurno
enum<string>
default:turnoFixo

Tipo do turno dos colaboradores do fechamento

Available options:
turnoFixo,
turnoFlexivel,
turnoRevezamento,
turnoCiclo