Skip to main content
POST
Realiza download de um arquivo unificado de relatório

Body

application/json

Dados para download e unificação de arquivos

reportId
string
required

ID do relatório

Example:

"123-456abc"

extension
enum<string>
default:pdf
required

Extensão do arquivo unificado

Available options:
pdf,
zip
fileIds
string[]

IDs dos arquivos do relatório a serem unificados

Example:
groupBy
enum<string>
default:BUSINESS_UNIT

Agrupamento dos arquivos de colaboradores, caso desejado, para um relatório de espelho de ponto

Available options:
BUSINESS_UNIT,
DEPARTMENT

Response

Relatório

relatorioId
string
required

ID do relatório

Example:

"123-456abc"

codigo
number
required

Código do relatório

Example:

12

tipo
enum<string>
default:AFD
required

Tipo do relatório

Available options:
AFD,
AEJ,
ESPELHO_PONTO,
BANCO_HORAS,
HORAS_EXTRAS,
HORAS_EXTRAS_ADICIONAL_NOTURNO,
LOCALIZACOES,
FALTAS_ATRASOS_ANTECIPACOES,
EVENTOS_FOLHA_PAGAMENTO
status
enum<string>
default:PRONTO
required

Status do relatório

Available options:
PROCESSANDO,
PRONTO,
EXPIRADO,
ERRO,
AVISO
dataInicial
string<date-time>
required

Data inicial

Example:

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

dataFinal
string<date-time>
required

Data final

Example:

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

createdAt
string<date-time>
required

Data de criação do relatório

Example:

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

nomeArquivo
string

Nome do arquivo

Example:

"AFD512024001739947317871000105REP_P.txt"

importado
boolean

Indica se o relatório foi importado

Example:

false

updatedAt
string<date-time>

Data de atualização do relatório

Example:

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

url
string

Url para download do arquivo

Example:

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

extension
enum<string>
default:pdf

Extensão do(s) arquivo(s) de relatório

Available options:
csv,
pdf,
txt,
zip
unidadeNegocio
object

Unidade de negócio do relatório

files
object[]

Arquivos do relatório