Class PaymentsAndNonRevenueGroupedOverTime

    • Constructor Detail

      • PaymentsAndNonRevenueGroupedOverTime

        public PaymentsAndNonRevenueGroupedOverTime()
        Constructs a new empty instance.
      • PaymentsAndNonRevenueGroupedOverTime

        protected PaymentsAndNonRevenueGroupedOverTime​(boolean noInit)
        Constructs a new empty instance.
      • PaymentsAndNonRevenueGroupedOverTime

        public PaymentsAndNonRevenueGroupedOverTime​(JSONObject jsonObject)
        Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
      • PaymentsAndNonRevenueGroupedOverTime

        public PaymentsAndNonRevenueGroupedOverTime​(PaymentsAndNonRevenueGroupedOverTime src)
        Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
    • Method Detail

      • getSalesSummaries

        public SalesSummarySection getSalesSummaries()
        Summaries grouped over time of Gross Sales, Net Sales, Amount Collected and the other figures that contribute to their calculation like total Taxes, Discounts, Refunds, Service Charges, Tips, Non-revenue Items and Gift Card Activations.
      • getPayments

        public SummarySection getPayments()
        Summaries grouped over time of payments. Does not include items marked non-revenue.
      • getNonRevenue

        public SummarySection getNonRevenue()
        Summaries grouped over time of sales of items marked non-revenue including modifiers and discounts.
      • getCredits

        public SummarySection getCredits()
        Summaries grouped over time of credits, also known as manual or naked refunds.
      • getRefunds

        public SummarySection getRefunds()
        Summaries grouped over time of refunds.
      • getAuthorizations

        public SummarySection getAuthorizations()
        Summaries grouped over time of authorizations. In this context authorizations are entities stored in the payment table with the payment result of 'auth'.
      • getDiscounts

        public SummarySection getDiscounts()
        Summaries grouped over time of discounts.
      • getOpenOrders

        public SummarySection getOpenOrders()
        Summaries grouped over time of open orders. Open orders are orders that still require more payments.
      • getTop5Items

        public SummarySection getTop5Items()
        Summaries grouped over time showing top 5 line items in terms of revenue.
      • getTop5Category

        public SummarySection getTop5Category()
        Summaries grouped by category, showing top 5 category of line items sold in terms of revenue.
      • getTop5RevenueClasses

        public SummarySection getTop5RevenueClasses()
        Summaries grouped by revenue class, AKA labels, showing top 5 revenue class of items sold in terms of revenue.
      • getPeriod

        public TimePeriod getPeriod()
        The time period that defines the size of the groups: hour, day, week, month, ungrouped.
      • getTendersSection

        public ReportPaymentsV2Section getTendersSection()
        Summary of payments and refunds by tender.
      • getRevenueClasses

        public LabelSummarySection getRevenueClasses()
        Full report of revenue items sold based on revenue classes AKA labels summary.
      • getCardTypesSection

        public ReportPaymentsV2Section getCardTypesSection()
        Summary of payments and refunds by card type.
      • getCashDepositSection

        public DeviceCashSummaryRow getCashDepositSection()
        Summary and further details on cash transactions
      • getDeclinedOfflinePaymentsSection

        public ReportPaymentsV2Row getDeclinedOfflinePaymentsSection()
        Summary of declined offline payments
      • getJSONObject

        public JSONObject getJSONObject()
        Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.
        Specified by:
        getJSONObject in interface JSONifiable
      • isNotNullSalesSummaries

        public boolean isNotNullSalesSummaries()
        Checks whether the 'salesSummaries' field is set and is not null
      • isNotNullPayments

        public boolean isNotNullPayments()
        Checks whether the 'payments' field is set and is not null
      • isNotNullNonRevenue

        public boolean isNotNullNonRevenue()
        Checks whether the 'nonRevenue' field is set and is not null
      • isNotNullCredits

        public boolean isNotNullCredits()
        Checks whether the 'credits' field is set and is not null
      • isNotNullRefunds

        public boolean isNotNullRefunds()
        Checks whether the 'refunds' field is set and is not null
      • isNotNullAuthorizations

        public boolean isNotNullAuthorizations()
        Checks whether the 'authorizations' field is set and is not null
      • isNotNullDiscounts

        public boolean isNotNullDiscounts()
        Checks whether the 'discounts' field is set and is not null
      • isNotNullOpenOrders

        public boolean isNotNullOpenOrders()
        Checks whether the 'openOrders' field is set and is not null
      • isNotNullTop5Items

        public boolean isNotNullTop5Items()
        Checks whether the 'top5Items' field is set and is not null
      • isNotNullTop5Category

        public boolean isNotNullTop5Category()
        Checks whether the 'top5Category' field is set and is not null
      • isNotNullTop5RevenueClasses

        public boolean isNotNullTop5RevenueClasses()
        Checks whether the 'top5RevenueClasses' field is set and is not null
      • isNotNullPeriod

        public boolean isNotNullPeriod()
        Checks whether the 'period' field is set and is not null
      • isNotNullTendersSection

        public boolean isNotNullTendersSection()
        Checks whether the 'tendersSection' field is set and is not null
      • isNotNullRevenueClasses

        public boolean isNotNullRevenueClasses()
        Checks whether the 'revenueClasses' field is set and is not null
      • isNotNullCardTypesSection

        public boolean isNotNullCardTypesSection()
        Checks whether the 'cardTypesSection' field is set and is not null
      • isNotNullCashDepositSection

        public boolean isNotNullCashDepositSection()
        Checks whether the 'cashDepositSection' field is set and is not null
      • isNotNullDeclinedOfflinePaymentsSection

        public boolean isNotNullDeclinedOfflinePaymentsSection()
        Checks whether the 'declinedOfflinePaymentsSection' field is set and is not null
      • hasSalesSummaries

        public boolean hasSalesSummaries()
        Checks whether the 'salesSummaries' field has been set, however the value could be null
      • hasPayments

        public boolean hasPayments()
        Checks whether the 'payments' field has been set, however the value could be null
      • hasNonRevenue

        public boolean hasNonRevenue()
        Checks whether the 'nonRevenue' field has been set, however the value could be null
      • hasCredits

        public boolean hasCredits()
        Checks whether the 'credits' field has been set, however the value could be null
      • hasRefunds

        public boolean hasRefunds()
        Checks whether the 'refunds' field has been set, however the value could be null
      • hasAuthorizations

        public boolean hasAuthorizations()
        Checks whether the 'authorizations' field has been set, however the value could be null
      • hasDiscounts

        public boolean hasDiscounts()
        Checks whether the 'discounts' field has been set, however the value could be null
      • hasOpenOrders

        public boolean hasOpenOrders()
        Checks whether the 'openOrders' field has been set, however the value could be null
      • hasTop5Items

        public boolean hasTop5Items()
        Checks whether the 'top5Items' field has been set, however the value could be null
      • hasTop5Category

        public boolean hasTop5Category()
        Checks whether the 'top5Category' field has been set, however the value could be null
      • hasTop5RevenueClasses

        public boolean hasTop5RevenueClasses()
        Checks whether the 'top5RevenueClasses' field has been set, however the value could be null
      • hasPeriod

        public boolean hasPeriod()
        Checks whether the 'period' field has been set, however the value could be null
      • hasTendersSection

        public boolean hasTendersSection()
        Checks whether the 'tendersSection' field has been set, however the value could be null
      • hasRevenueClasses

        public boolean hasRevenueClasses()
        Checks whether the 'revenueClasses' field has been set, however the value could be null
      • hasCardTypesSection

        public boolean hasCardTypesSection()
        Checks whether the 'cardTypesSection' field has been set, however the value could be null
      • hasCashDepositSection

        public boolean hasCashDepositSection()
        Checks whether the 'cashDepositSection' field has been set, however the value could be null
      • hasDeclinedOfflinePaymentsSection

        public boolean hasDeclinedOfflinePaymentsSection()
        Checks whether the 'declinedOfflinePaymentsSection' field has been set, however the value could be null
      • setTop5RevenueClasses

        public PaymentsAndNonRevenueGroupedOverTime setTop5RevenueClasses​(SummarySection top5RevenueClasses)
        Sets the field 'top5RevenueClasses'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
      • setDeclinedOfflinePaymentsSection

        public PaymentsAndNonRevenueGroupedOverTime setDeclinedOfflinePaymentsSection​(ReportPaymentsV2Row declinedOfflinePaymentsSection)
        Sets the field 'declinedOfflinePaymentsSection'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
      • clearSalesSummaries

        public void clearSalesSummaries()
        Clears the 'salesSummaries' field, the 'has' method for this field will now return false
      • clearPayments

        public void clearPayments()
        Clears the 'payments' field, the 'has' method for this field will now return false
      • clearNonRevenue

        public void clearNonRevenue()
        Clears the 'nonRevenue' field, the 'has' method for this field will now return false
      • clearCredits

        public void clearCredits()
        Clears the 'credits' field, the 'has' method for this field will now return false
      • clearRefunds

        public void clearRefunds()
        Clears the 'refunds' field, the 'has' method for this field will now return false
      • clearAuthorizations

        public void clearAuthorizations()
        Clears the 'authorizations' field, the 'has' method for this field will now return false
      • clearDiscounts

        public void clearDiscounts()
        Clears the 'discounts' field, the 'has' method for this field will now return false
      • clearOpenOrders

        public void clearOpenOrders()
        Clears the 'openOrders' field, the 'has' method for this field will now return false
      • clearTop5Items

        public void clearTop5Items()
        Clears the 'top5Items' field, the 'has' method for this field will now return false
      • clearTop5Category

        public void clearTop5Category()
        Clears the 'top5Category' field, the 'has' method for this field will now return false
      • clearTop5RevenueClasses

        public void clearTop5RevenueClasses()
        Clears the 'top5RevenueClasses' field, the 'has' method for this field will now return false
      • clearPeriod

        public void clearPeriod()
        Clears the 'period' field, the 'has' method for this field will now return false
      • clearTendersSection

        public void clearTendersSection()
        Clears the 'tendersSection' field, the 'has' method for this field will now return false
      • clearRevenueClasses

        public void clearRevenueClasses()
        Clears the 'revenueClasses' field, the 'has' method for this field will now return false
      • clearCardTypesSection

        public void clearCardTypesSection()
        Clears the 'cardTypesSection' field, the 'has' method for this field will now return false
      • clearCashDepositSection

        public void clearCashDepositSection()
        Clears the 'cashDepositSection' field, the 'has' method for this field will now return false
      • clearDeclinedOfflinePaymentsSection

        public void clearDeclinedOfflinePaymentsSection()
        Clears the 'declinedOfflinePaymentsSection' field, the 'has' method for this field will now return false
      • containsChanges

        public boolean containsChanges()
        Returns true if this instance has any changes.
      • resetChangeLog

        public void resetChangeLog()
        Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.