Package com.clover.sdk.v3.report

Class ReportItem

    • Constructor Detail

      • ReportItem

        public ReportItem()
        Constructs a new empty instance.

      • ReportItem

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

      • ReportItem

        public ReportItem​(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.

      • ReportItem

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

    • Method Detail

      • getId

        public String getId()

      • getName

        public String getName()

      • getNumberSold

        public Double getNumberSold()

      • getRevenueSold

        public Long getRevenueSold()
        This is item gross sales for line items where is_revenue=true. It is the item value before discounts and refunds. Does not include non-revenue items and modifier gross sales.

      • getNumNonRevenueSold

        public Double getNumNonRevenueSold()

      • getPriceSold

        public Double getPriceSold()

      • getNumRefunds

        public Double getNumRefunds()

      • getRefundAmount

        public Long getRefundAmount()
        Total value of items that were fully refunded. This excludes amounts that were later fully repaid. This is for the original design of the report from 2019.

      • getRefundAmountRegardlessOfRepayment

        public Long getRefundAmountRegardlessOfRepayment()
        Total value of items that were fully refunded. This includes amounts that were later fully repaid. This is for the amendment to the design of the report in 2020 to separate the display of refund repayments from refunds.

      • getRefundRepaymentAmount

        public Long getRefundRepaymentAmount()
        Total value of items that were fully refunded and then later fully repaid.

      • getNumExchanges

        public Double getNumExchanges()

      • getExchangeAmount

        public Long getExchangeAmount()

      • getInACategory

        public Boolean getInACategory()

      • getInventoryItem

        public Item getInventoryItem()

      • getDiscountSales

        public List<BaseSale> getDiscountSales()

      • getOrderLevelDiscounts

        public List<BaseSale> getOrderLevelDiscounts()

      • getCategories

        @Deprecated
public List<ItemSalesBucket> getCategories()
        Deprecated.
        DEPRECATED. Use 'category'. In practice this is the oldest active category that the item belongs to. If there are no categories for this item, then this is empty. If item belongs to categories that are all deleted, then this is not populated.

      • getDeletedCategories

        @Deprecated
public List<ItemSalesBucket> getDeletedCategories()
        Deprecated.
        DEPRECATED. Use 'category'. In practice if the item belongs to only categories that are deleted, then this is most recently deleted category. If the item is in an active category then this is not populated.

      • getModifierSales

        public List<BaseSale> getModifierSales()

      • getGrossModifierSales

        public Long getGrossModifierSales()
        Total value of all modifiers sold for this item.

      • getTotalDiscounts

        public Long getTotalDiscounts()
        Total value of line item discounts and order level discounts. Order level discounts are an estimate of how much of the order level discount can be attributed to the line item. Units are cents. Fractional cents are rounded to the nearest cent.

      • getTotalDiscountsFractionalCents

        public Double getTotalDiscountsFractionalCents()
        Total value of line item discounts and order level discounts. Order level discounts are an estimate of how much of the order level discount can be attributed to the line item. Units are cents. Fractional cents are preserved.

      • getNetNumberSold

        public Double getNetNumberSold()
        The number sold minus the number refunded and exchanged.

      • getGrossItemSales

        public Long getGrossItemSales()
        Item value before discounts and refunds. Does not include modifier gross sales.

      • getGrossSales

        public Long getGrossSales()
        Total value of sales of this item with modifiers before refunds and without taxes, discounts and service charges. Sum of Gross Modifier Sales and Gross Item Sales.

      • getNetItemSales

        public Long getNetItemSales()
        Total value of sales of this item after refunds and with discounts. Does not include modifier sales.

      • getNetModifierSales

        public Long getNetModifierSales()
        Total value of all modifiers sold for this item minus total value of all modifiers refunded.

      • getNetSales

        public Long getNetSales()
        Total value of sales of this item with modifiers after refunds and with discounts. Sum of Net Modifier Sales and Net Item Sales. Units are cents. Rounded to the nearest penny.

      • getNetSalesFractionalCents

        public Double getNetSalesFractionalCents()
        Total value of sales of this item with modifiers after refunds and with discounts. Sum of Net Modifier Sales and Net Item Sales. Units are cents. Decimal portion is fractional cents.

      • getCostOfGoodsSold

        public Long getCostOfGoodsSold()
        Cost of Goods Sold (COGS): net quantity sold multiplied by the cost.

      • getGrossProfit

        public Long getGrossProfit()
        Gross sales minus cost of goods sold.

      • getGrossProfitMargin

        public Double getGrossProfitMargin()
        Gross profit divided by gross sales.

      • getAverageNetSales

        public Long getAverageNetSales()
        Net sales divided by net number sold.

      • getPercentTotalNetSales

        public Double getPercentTotalNetSales()
        The percentage of the net sales of this item versus total net sales of all revenue items or of all non-revenue items.

      • getPartialRefundAmount

        public Long getPartialRefundAmount()
        Total amount of refunds that partially refunded the item but did not fully refund the item, in units of cents. Rounded to the nearest penny.

      • getPartialRefundRepaymentAmount

        public Long getPartialRefundRepaymentAmount()
        Total amount of refunds that partially refunded the item but did not fully refund the item and then were later re-paid, in units of cents. Rounded to the nearest penny.

      • getCategory

        public ItemSalesBucket getCategory()
        The oldest active category that the item belongs to. If item belongs to categories that are all deleted, then this is the most recently deleted category. If there are no categories for this item, then this is empty.

      • getSegmentLabel

        public Integer getSegmentLabel()
        An identifier that may be used to align report segments across different merchants.

      • getStartTimestamp

        public Long getStartTimestamp()
        Beginning of the time period for this summary

      • getEndTimestamp

        public Long getEndTimestamp()
        End of the time period for this summary

      • getChangeInNetSales

        public Double getChangeInNetSales()
        Change in net sales comparing the previous period to this period. Expressed as a proportion: 0.5 = 50% increase, -0.75 = 75% decrease, 0 = no change, null = previous period had no sales, 1.2 = 120% increase.

      • getChangeInNetNumberSold

        public Double getChangeInNetNumberSold()
        Change in net quantity comparing the previous period to this period. Expressed as a proportion: 0.5 = 50% increase, -0.75 = 75% decrease, 0 = no change, null = previous period had no sales, 1.2 = 120% increase.

      • 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

      • isNotNullId

        public boolean isNotNullId()
        Checks whether the 'id' field is set and is not null

      • isNotNullName

        public boolean isNotNullName()
        Checks whether the 'name' field is set and is not null

      • isNotNullNumberSold

        public boolean isNotNullNumberSold()
        Checks whether the 'numberSold' field is set and is not null

      • isNotNullRevenueSold

        public boolean isNotNullRevenueSold()
        Checks whether the 'revenueSold' field is set and is not null

      • isNotNullNumNonRevenueSold

        public boolean isNotNullNumNonRevenueSold()
        Checks whether the 'numNonRevenueSold' field is set and is not null

      • isNotNullPriceSold

        public boolean isNotNullPriceSold()
        Checks whether the 'priceSold' field is set and is not null

      • isNotNullNumRefunds

        public boolean isNotNullNumRefunds()
        Checks whether the 'numRefunds' field is set and is not null

      • isNotNullRefundAmount

        public boolean isNotNullRefundAmount()
        Checks whether the 'refundAmount' field is set and is not null

      • isNotNullRefundAmountRegardlessOfRepayment

        public boolean isNotNullRefundAmountRegardlessOfRepayment()
        Checks whether the 'refundAmountRegardlessOfRepayment' field is set and is not null

      • isNotNullRefundRepaymentAmount

        public boolean isNotNullRefundRepaymentAmount()
        Checks whether the 'refundRepaymentAmount' field is set and is not null

      • isNotNullNumExchanges

        public boolean isNotNullNumExchanges()
        Checks whether the 'numExchanges' field is set and is not null

      • isNotNullExchangeAmount

        public boolean isNotNullExchangeAmount()
        Checks whether the 'exchangeAmount' field is set and is not null

      • isNotNullInACategory

        public boolean isNotNullInACategory()
        Checks whether the 'inACategory' field is set and is not null

      • isNotNullInventoryItem

        public boolean isNotNullInventoryItem()
        Checks whether the 'inventoryItem' field is set and is not null

      • isNotNullDiscountSales

        public boolean isNotNullDiscountSales()
        Checks whether the 'discountSales' field is set and is not null

      • isNotEmptyDiscountSales

        public boolean isNotEmptyDiscountSales()
        Checks whether the 'discountSales' field is set and is not null and is not empty

      • isNotNullOrderLevelDiscounts

        public boolean isNotNullOrderLevelDiscounts()
        Checks whether the 'orderLevelDiscounts' field is set and is not null

      • isNotEmptyOrderLevelDiscounts

        public boolean isNotEmptyOrderLevelDiscounts()
        Checks whether the 'orderLevelDiscounts' field is set and is not null and is not empty

      • isNotNullLabels

        public boolean isNotNullLabels()
        Checks whether the 'labels' field is set and is not null

      • isNotEmptyLabels

        public boolean isNotEmptyLabels()
        Checks whether the 'labels' field is set and is not null and is not empty

      • isNotNullCategories

        public boolean isNotNullCategories()
        Checks whether the 'categories' field is set and is not null

      • isNotEmptyCategories

        public boolean isNotEmptyCategories()
        Checks whether the 'categories' field is set and is not null and is not empty

      • isNotNullDeletedCategories

        public boolean isNotNullDeletedCategories()
        Checks whether the 'deletedCategories' field is set and is not null

      • isNotEmptyDeletedCategories

        public boolean isNotEmptyDeletedCategories()
        Checks whether the 'deletedCategories' field is set and is not null and is not empty

      • isNotNullModifierSales

        public boolean isNotNullModifierSales()
        Checks whether the 'modifierSales' field is set and is not null

      • isNotEmptyModifierSales

        public boolean isNotEmptyModifierSales()
        Checks whether the 'modifierSales' field is set and is not null and is not empty

      • isNotNullGrossModifierSales

        public boolean isNotNullGrossModifierSales()
        Checks whether the 'grossModifierSales' field is set and is not null

      • isNotNullTotalDiscounts

        public boolean isNotNullTotalDiscounts()
        Checks whether the 'totalDiscounts' field is set and is not null

      • isNotNullTotalDiscountsFractionalCents

        public boolean isNotNullTotalDiscountsFractionalCents()
        Checks whether the 'totalDiscountsFractionalCents' field is set and is not null

      • isNotNullNetNumberSold

        public boolean isNotNullNetNumberSold()
        Checks whether the 'netNumberSold' field is set and is not null

      • isNotNullGrossItemSales

        public boolean isNotNullGrossItemSales()
        Checks whether the 'grossItemSales' field is set and is not null

      • isNotNullGrossSales

        public boolean isNotNullGrossSales()
        Checks whether the 'grossSales' field is set and is not null

      • isNotNullNetItemSales

        public boolean isNotNullNetItemSales()
        Checks whether the 'netItemSales' field is set and is not null

      • isNotNullNetModifierSales

        public boolean isNotNullNetModifierSales()
        Checks whether the 'netModifierSales' field is set and is not null

      • isNotNullNetSales

        public boolean isNotNullNetSales()
        Checks whether the 'netSales' field is set and is not null

      • isNotNullNetSalesFractionalCents

        public boolean isNotNullNetSalesFractionalCents()
        Checks whether the 'netSalesFractionalCents' field is set and is not null

      • isNotNullCostOfGoodsSold

        public boolean isNotNullCostOfGoodsSold()
        Checks whether the 'costOfGoodsSold' field is set and is not null

      • isNotNullGrossProfit

        public boolean isNotNullGrossProfit()
        Checks whether the 'grossProfit' field is set and is not null

      • isNotNullGrossProfitMargin

        public boolean isNotNullGrossProfitMargin()
        Checks whether the 'grossProfitMargin' field is set and is not null

      • isNotNullAverageNetSales

        public boolean isNotNullAverageNetSales()
        Checks whether the 'averageNetSales' field is set and is not null

      • isNotNullPercentTotalNetSales

        public boolean isNotNullPercentTotalNetSales()
        Checks whether the 'percentTotalNetSales' field is set and is not null

      • isNotNullPartialRefundAmount

        public boolean isNotNullPartialRefundAmount()
        Checks whether the 'partialRefundAmount' field is set and is not null

      • isNotNullPartialRefundRepaymentAmount

        public boolean isNotNullPartialRefundRepaymentAmount()
        Checks whether the 'partialRefundRepaymentAmount' field is set and is not null

      • isNotNullCategory

        public boolean isNotNullCategory()
        Checks whether the 'category' field is set and is not null

      • isNotNullSegmentLabel

        public boolean isNotNullSegmentLabel()
        Checks whether the 'segmentLabel' field is set and is not null

      • isNotNullStartTimestamp

        public boolean isNotNullStartTimestamp()
        Checks whether the 'startTimestamp' field is set and is not null

      • isNotNullEndTimestamp

        public boolean isNotNullEndTimestamp()
        Checks whether the 'endTimestamp' field is set and is not null

      • isNotNullChangeInNetSales

        public boolean isNotNullChangeInNetSales()
        Checks whether the 'changeInNetSales' field is set and is not null

      • isNotNullChangeInNetNumberSold

        public boolean isNotNullChangeInNetNumberSold()
        Checks whether the 'changeInNetNumberSold' field is set and is not null

      • hasId

        public boolean hasId()
        Checks whether the 'id' field has been set, however the value could be null

      • hasName

        public boolean hasName()
        Checks whether the 'name' field has been set, however the value could be null

      • hasNumberSold

        public boolean hasNumberSold()
        Checks whether the 'numberSold' field has been set, however the value could be null

      • hasRevenueSold

        public boolean hasRevenueSold()
        Checks whether the 'revenueSold' field has been set, however the value could be null

      • hasNumNonRevenueSold

        public boolean hasNumNonRevenueSold()
        Checks whether the 'numNonRevenueSold' field has been set, however the value could be null

      • hasPriceSold

        public boolean hasPriceSold()
        Checks whether the 'priceSold' field has been set, however the value could be null

      • hasNumRefunds

        public boolean hasNumRefunds()
        Checks whether the 'numRefunds' field has been set, however the value could be null

      • hasRefundAmount

        public boolean hasRefundAmount()
        Checks whether the 'refundAmount' field has been set, however the value could be null

      • hasRefundAmountRegardlessOfRepayment

        public boolean hasRefundAmountRegardlessOfRepayment()
        Checks whether the 'refundAmountRegardlessOfRepayment' field has been set, however the value could be null

      • hasRefundRepaymentAmount

        public boolean hasRefundRepaymentAmount()
        Checks whether the 'refundRepaymentAmount' field has been set, however the value could be null

      • hasNumExchanges

        public boolean hasNumExchanges()
        Checks whether the 'numExchanges' field has been set, however the value could be null

      • hasExchangeAmount

        public boolean hasExchangeAmount()
        Checks whether the 'exchangeAmount' field has been set, however the value could be null

      • hasInACategory

        public boolean hasInACategory()
        Checks whether the 'inACategory' field has been set, however the value could be null

      • hasInventoryItem

        public boolean hasInventoryItem()
        Checks whether the 'inventoryItem' field has been set, however the value could be null

      • hasDiscountSales

        public boolean hasDiscountSales()
        Checks whether the 'discountSales' field has been set, however the value could be null

      • hasOrderLevelDiscounts

        public boolean hasOrderLevelDiscounts()
        Checks whether the 'orderLevelDiscounts' field has been set, however the value could be null

      • hasLabels

        public boolean hasLabels()
        Checks whether the 'labels' field has been set, however the value could be null

      • hasCategories

        public boolean hasCategories()
        Checks whether the 'categories' field has been set, however the value could be null

      • hasDeletedCategories

        public boolean hasDeletedCategories()
        Checks whether the 'deletedCategories' field has been set, however the value could be null

      • hasModifierSales

        public boolean hasModifierSales()
        Checks whether the 'modifierSales' field has been set, however the value could be null

      • hasGrossModifierSales

        public boolean hasGrossModifierSales()
        Checks whether the 'grossModifierSales' field has been set, however the value could be null

      • hasTotalDiscounts

        public boolean hasTotalDiscounts()
        Checks whether the 'totalDiscounts' field has been set, however the value could be null

      • hasTotalDiscountsFractionalCents

        public boolean hasTotalDiscountsFractionalCents()
        Checks whether the 'totalDiscountsFractionalCents' field has been set, however the value could be null

      • hasNetNumberSold

        public boolean hasNetNumberSold()
        Checks whether the 'netNumberSold' field has been set, however the value could be null

      • hasGrossItemSales

        public boolean hasGrossItemSales()
        Checks whether the 'grossItemSales' field has been set, however the value could be null

      • hasGrossSales

        public boolean hasGrossSales()
        Checks whether the 'grossSales' field has been set, however the value could be null

      • hasNetItemSales

        public boolean hasNetItemSales()
        Checks whether the 'netItemSales' field has been set, however the value could be null

      • hasNetModifierSales

        public boolean hasNetModifierSales()
        Checks whether the 'netModifierSales' field has been set, however the value could be null

      • hasNetSales

        public boolean hasNetSales()
        Checks whether the 'netSales' field has been set, however the value could be null

      • hasNetSalesFractionalCents

        public boolean hasNetSalesFractionalCents()
        Checks whether the 'netSalesFractionalCents' field has been set, however the value could be null

      • hasCostOfGoodsSold

        public boolean hasCostOfGoodsSold()
        Checks whether the 'costOfGoodsSold' field has been set, however the value could be null

      • hasGrossProfit

        public boolean hasGrossProfit()
        Checks whether the 'grossProfit' field has been set, however the value could be null

      • hasGrossProfitMargin

        public boolean hasGrossProfitMargin()
        Checks whether the 'grossProfitMargin' field has been set, however the value could be null

      • hasAverageNetSales

        public boolean hasAverageNetSales()
        Checks whether the 'averageNetSales' field has been set, however the value could be null

      • hasPercentTotalNetSales

        public boolean hasPercentTotalNetSales()
        Checks whether the 'percentTotalNetSales' field has been set, however the value could be null

      • hasPartialRefundAmount

        public boolean hasPartialRefundAmount()
        Checks whether the 'partialRefundAmount' field has been set, however the value could be null

      • hasPartialRefundRepaymentAmount

        public boolean hasPartialRefundRepaymentAmount()
        Checks whether the 'partialRefundRepaymentAmount' field has been set, however the value could be null

      • hasCategory

        public boolean hasCategory()
        Checks whether the 'category' field has been set, however the value could be null

      • hasSegmentLabel

        public boolean hasSegmentLabel()
        Checks whether the 'segmentLabel' field has been set, however the value could be null

      • hasStartTimestamp

        public boolean hasStartTimestamp()
        Checks whether the 'startTimestamp' field has been set, however the value could be null

      • hasEndTimestamp

        public boolean hasEndTimestamp()
        Checks whether the 'endTimestamp' field has been set, however the value could be null

      • hasChangeInNetSales

        public boolean hasChangeInNetSales()
        Checks whether the 'changeInNetSales' field has been set, however the value could be null

      • hasChangeInNetNumberSold

        public boolean hasChangeInNetNumberSold()
        Checks whether the 'changeInNetNumberSold' field has been set, however the value could be null

      • setNumberSold

        public ReportItem setNumberSold​(Double numberSold)
        Sets the field 'numberSold'.

      • setRevenueSold

        public ReportItem setRevenueSold​(Long revenueSold)
        Sets the field 'revenueSold'.

      • setNumNonRevenueSold

        public ReportItem setNumNonRevenueSold​(Double numNonRevenueSold)
        Sets the field 'numNonRevenueSold'.

      • setPriceSold

        public ReportItem setPriceSold​(Double priceSold)
        Sets the field 'priceSold'.

      • setNumRefunds

        public ReportItem setNumRefunds​(Double numRefunds)
        Sets the field 'numRefunds'.

      • setRefundAmount

        public ReportItem setRefundAmount​(Long refundAmount)
        Sets the field 'refundAmount'.

      • setRefundAmountRegardlessOfRepayment

        public ReportItem setRefundAmountRegardlessOfRepayment​(Long refundAmountRegardlessOfRepayment)
        Sets the field 'refundAmountRegardlessOfRepayment'.

      • setRefundRepaymentAmount

        public ReportItem setRefundRepaymentAmount​(Long refundRepaymentAmount)
        Sets the field 'refundRepaymentAmount'.

      • setNumExchanges

        public ReportItem setNumExchanges​(Double numExchanges)
        Sets the field 'numExchanges'.

      • setExchangeAmount

        public ReportItem setExchangeAmount​(Long exchangeAmount)
        Sets the field 'exchangeAmount'.

      • setInACategory

        public ReportItem setInACategory​(Boolean inACategory)
        Sets the field 'inACategory'.

      • setInventoryItem

        public ReportItem setInventoryItem​(Item inventoryItem)
        Sets the field 'inventoryItem'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.

      • setDiscountSales

        public ReportItem setDiscountSales​(List<BaseSale> discountSales)
        Sets the field 'discountSales'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setOrderLevelDiscounts

        public ReportItem setOrderLevelDiscounts​(List<BaseSale> orderLevelDiscounts)
        Sets the field 'orderLevelDiscounts'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setLabels

        public ReportItem setLabels​(List<ReportLabel> labels)
        Sets the field 'labels'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setCategories

        public ReportItem setCategories​(List<ItemSalesBucket> categories)
        Sets the field 'categories'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setDeletedCategories

        public ReportItem setDeletedCategories​(List<ItemSalesBucket> deletedCategories)
        Sets the field 'deletedCategories'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setModifierSales

        public ReportItem setModifierSales​(List<BaseSale> modifierSales)
        Sets the field 'modifierSales'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.

      • setGrossModifierSales

        public ReportItem setGrossModifierSales​(Long grossModifierSales)
        Sets the field 'grossModifierSales'.

      • setTotalDiscounts

        public ReportItem setTotalDiscounts​(Long totalDiscounts)
        Sets the field 'totalDiscounts'.

      • setTotalDiscountsFractionalCents

        public ReportItem setTotalDiscountsFractionalCents​(Double totalDiscountsFractionalCents)
        Sets the field 'totalDiscountsFractionalCents'.

      • setNetNumberSold

        public ReportItem setNetNumberSold​(Double netNumberSold)
        Sets the field 'netNumberSold'.

      • setGrossItemSales

        public ReportItem setGrossItemSales​(Long grossItemSales)
        Sets the field 'grossItemSales'.

      • setGrossSales

        public ReportItem setGrossSales​(Long grossSales)
        Sets the field 'grossSales'.

      • setNetItemSales

        public ReportItem setNetItemSales​(Long netItemSales)
        Sets the field 'netItemSales'.

      • setNetModifierSales

        public ReportItem setNetModifierSales​(Long netModifierSales)
        Sets the field 'netModifierSales'.

      • setNetSales

        public ReportItem setNetSales​(Long netSales)
        Sets the field 'netSales'.

      • setNetSalesFractionalCents

        public ReportItem setNetSalesFractionalCents​(Double netSalesFractionalCents)
        Sets the field 'netSalesFractionalCents'.

      • setCostOfGoodsSold

        public ReportItem setCostOfGoodsSold​(Long costOfGoodsSold)
        Sets the field 'costOfGoodsSold'.

      • setGrossProfit

        public ReportItem setGrossProfit​(Long grossProfit)
        Sets the field 'grossProfit'.

      • setGrossProfitMargin

        public ReportItem setGrossProfitMargin​(Double grossProfitMargin)
        Sets the field 'grossProfitMargin'.

      • setAverageNetSales

        public ReportItem setAverageNetSales​(Long averageNetSales)
        Sets the field 'averageNetSales'.

      • setPercentTotalNetSales

        public ReportItem setPercentTotalNetSales​(Double percentTotalNetSales)
        Sets the field 'percentTotalNetSales'.

      • setPartialRefundAmount

        public ReportItem setPartialRefundAmount​(Long partialRefundAmount)
        Sets the field 'partialRefundAmount'.

      • setPartialRefundRepaymentAmount

        public ReportItem setPartialRefundRepaymentAmount​(Long partialRefundRepaymentAmount)
        Sets the field 'partialRefundRepaymentAmount'.

      • setCategory

        public ReportItem setCategory​(ItemSalesBucket category)
        Sets the field 'category'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.

      • setSegmentLabel

        public ReportItem setSegmentLabel​(Integer segmentLabel)
        Sets the field 'segmentLabel'.

      • setStartTimestamp

        public ReportItem setStartTimestamp​(Long startTimestamp)
        Sets the field 'startTimestamp'.

      • setEndTimestamp

        public ReportItem setEndTimestamp​(Long endTimestamp)
        Sets the field 'endTimestamp'.

      • setChangeInNetSales

        public ReportItem setChangeInNetSales​(Double changeInNetSales)
        Sets the field 'changeInNetSales'.

      • setChangeInNetNumberSold

        public ReportItem setChangeInNetNumberSold​(Double changeInNetNumberSold)
        Sets the field 'changeInNetNumberSold'.

      • clearId

        public void clearId()
        Clears the 'id' field, the 'has' method for this field will now return false

      • clearName

        public void clearName()
        Clears the 'name' field, the 'has' method for this field will now return false

      • clearNumberSold

        public void clearNumberSold()
        Clears the 'numberSold' field, the 'has' method for this field will now return false

      • clearRevenueSold

        public void clearRevenueSold()
        Clears the 'revenueSold' field, the 'has' method for this field will now return false

      • clearNumNonRevenueSold

        public void clearNumNonRevenueSold()
        Clears the 'numNonRevenueSold' field, the 'has' method for this field will now return false

      • clearPriceSold

        public void clearPriceSold()
        Clears the 'priceSold' field, the 'has' method for this field will now return false

      • clearNumRefunds

        public void clearNumRefunds()
        Clears the 'numRefunds' field, the 'has' method for this field will now return false

      • clearRefundAmount

        public void clearRefundAmount()
        Clears the 'refundAmount' field, the 'has' method for this field will now return false

      • clearRefundAmountRegardlessOfRepayment

        public void clearRefundAmountRegardlessOfRepayment()
        Clears the 'refundAmountRegardlessOfRepayment' field, the 'has' method for this field will now return false

      • clearRefundRepaymentAmount

        public void clearRefundRepaymentAmount()
        Clears the 'refundRepaymentAmount' field, the 'has' method for this field will now return false

      • clearNumExchanges

        public void clearNumExchanges()
        Clears the 'numExchanges' field, the 'has' method for this field will now return false

      • clearExchangeAmount

        public void clearExchangeAmount()
        Clears the 'exchangeAmount' field, the 'has' method for this field will now return false

      • clearInACategory

        public void clearInACategory()
        Clears the 'inACategory' field, the 'has' method for this field will now return false

      • clearInventoryItem

        public void clearInventoryItem()
        Clears the 'inventoryItem' field, the 'has' method for this field will now return false

      • clearDiscountSales

        public void clearDiscountSales()
        Clears the 'discountSales' field, the 'has' method for this field will now return false

      • clearOrderLevelDiscounts

        public void clearOrderLevelDiscounts()
        Clears the 'orderLevelDiscounts' field, the 'has' method for this field will now return false

      • clearLabels

        public void clearLabels()
        Clears the 'labels' field, the 'has' method for this field will now return false

      • clearCategories

        public void clearCategories()
        Clears the 'categories' field, the 'has' method for this field will now return false

      • clearDeletedCategories

        public void clearDeletedCategories()
        Clears the 'deletedCategories' field, the 'has' method for this field will now return false

      • clearModifierSales

        public void clearModifierSales()
        Clears the 'modifierSales' field, the 'has' method for this field will now return false

      • clearGrossModifierSales

        public void clearGrossModifierSales()
        Clears the 'grossModifierSales' field, the 'has' method for this field will now return false

      • clearTotalDiscounts

        public void clearTotalDiscounts()
        Clears the 'totalDiscounts' field, the 'has' method for this field will now return false

      • clearTotalDiscountsFractionalCents

        public void clearTotalDiscountsFractionalCents()
        Clears the 'totalDiscountsFractionalCents' field, the 'has' method for this field will now return false

      • clearNetNumberSold

        public void clearNetNumberSold()
        Clears the 'netNumberSold' field, the 'has' method for this field will now return false

      • clearGrossItemSales

        public void clearGrossItemSales()
        Clears the 'grossItemSales' field, the 'has' method for this field will now return false

      • clearGrossSales

        public void clearGrossSales()
        Clears the 'grossSales' field, the 'has' method for this field will now return false

      • clearNetItemSales

        public void clearNetItemSales()
        Clears the 'netItemSales' field, the 'has' method for this field will now return false

      • clearNetModifierSales

        public void clearNetModifierSales()
        Clears the 'netModifierSales' field, the 'has' method for this field will now return false

      • clearNetSales

        public void clearNetSales()
        Clears the 'netSales' field, the 'has' method for this field will now return false

      • clearNetSalesFractionalCents

        public void clearNetSalesFractionalCents()
        Clears the 'netSalesFractionalCents' field, the 'has' method for this field will now return false

      • clearCostOfGoodsSold

        public void clearCostOfGoodsSold()
        Clears the 'costOfGoodsSold' field, the 'has' method for this field will now return false

      • clearGrossProfit

        public void clearGrossProfit()
        Clears the 'grossProfit' field, the 'has' method for this field will now return false

      • clearGrossProfitMargin

        public void clearGrossProfitMargin()
        Clears the 'grossProfitMargin' field, the 'has' method for this field will now return false

      • clearAverageNetSales

        public void clearAverageNetSales()
        Clears the 'averageNetSales' field, the 'has' method for this field will now return false

      • clearPercentTotalNetSales

        public void clearPercentTotalNetSales()
        Clears the 'percentTotalNetSales' field, the 'has' method for this field will now return false

      • clearPartialRefundAmount

        public void clearPartialRefundAmount()
        Clears the 'partialRefundAmount' field, the 'has' method for this field will now return false

      • clearPartialRefundRepaymentAmount

        public void clearPartialRefundRepaymentAmount()
        Clears the 'partialRefundRepaymentAmount' field, the 'has' method for this field will now return false

      • clearCategory

        public void clearCategory()
        Clears the 'category' field, the 'has' method for this field will now return false

      • clearSegmentLabel

        public void clearSegmentLabel()
        Clears the 'segmentLabel' field, the 'has' method for this field will now return false

      • clearStartTimestamp

        public void clearStartTimestamp()
        Clears the 'startTimestamp' field, the 'has' method for this field will now return false

      • clearEndTimestamp

        public void clearEndTimestamp()
        Clears the 'endTimestamp' field, the 'has' method for this field will now return false

      • clearChangeInNetSales

        public void clearChangeInNetSales()
        Clears the 'changeInNetSales' field, the 'has' method for this field will now return false

      • clearChangeInNetNumberSold

        public void clearChangeInNetNumberSold()
        Clears the 'changeInNetNumberSold' 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.

      • copyChanges

        public ReportItem copyChanges()
        Create a copy of this instance that contains only fields that were set after the constructor was called.

      • mergeChanges

        public void mergeChanges​(ReportItem src)
        Copy all the changed fields from the given source to this instance.