Relatórios

Faz-se uso da classe ReportRequestBuilder.

Informação

Os dados de transações/relatórios permanecem no banco de dados por 90 dias.

Relatórios disponíveis

Filtros

Os relatórios consolidado e detalhado podem ser gerados utilizando um intervalo customizado, ou um padrão do tipo hoje, ontem ou anteontem.

Exemplo — Intervalo fixo

ReportFilter(threshold = ReportThreshold.TODAY)                // Hoje
ReportFilter(threshold = ReportThreshold.YESTERDAY)            // Ontem
ReportFilter(threshold = ReportThreshold.DAY_BEFORE_YESTERDAY) // Anteontem

Exemplo — Intervalo customizado

// Este exemplo representa um intervalo do início do dia 18/05/2023 até o fim do dia 20/05/2023.
ReportFilter(
    threshold = ReportThreshold.CUSTOM,
    fromDate = DateParameters(18, 05, 2023),
    fromTime = TimeParameters(0, 0),
    toDate = DateParameters(20, 05, 2023),
    toTime = TimeParameters(23, 59),
)

data class DateParameters(
    val day: Int,
    val month: Int,
    val year: Int
) 

data class TimeParameters(
    val hour: Int,
    val minute: Int
)

Retornos

Este request retorna uma data class chamada ReportData, que pode conter um relatório consolidado, detalhado, ou de turno.

data class ReportData(
    val consolidatedReportData: ConsolidatedReportData? = null,
    val detailedReportData: DetailedReportData? = null,
    val closedShiftsReportData: ClosedShiftsReportData? = null
)