ReportItem
This is an auto-generated Clover data object.
Fields
- id
- name
- numberSold
- revenueSold
- numNonRevenueSold
- priceSold
- numRefunds
- refundAmount
- refundAmountRegardlessOfRepayment
- refundAmountRegardlessOfRepaymentFractionalCents
- refundRepaymentAmount
- refundRepaymentAmountFractionalCents
- numExchanges
- exchangeAmount
- inACategory
- inventoryItem
- discountSales
- orderLevelDiscounts
- labels
- categories
- deletedCategories
- modifierSales
- grossModifierSales
- totalDiscounts
- totalDiscountsFractionalCents
- netNumberSold
- grossItemSales
- grossSales
- netItemSales
- netItemSalesFractionalCents
- netModifierSales
- netModifierSalesFractionalCents
- netSales
- netSalesFractionalCents
- costOfGoodsSold
- grossProfit
- grossProfitMargin
- averageNetSales
- percentTotalNetSales
- partialRefundAmount
- partialRefundRepaymentAmount
- category
- segmentLabel
- startTimestamp
- endTimestamp
- changeInNetSales
- changeInNetNumberSold
- isRevenue
Constructors
Link copied to clipboard
Constructs a new empty instance.
Constructs a new instance from the given JSON String.
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.
Constructs a new instance that is a deep copy of the source instance.
Properties
Functions
Link copied to clipboard
Clears the 'averageNetSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'categories' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'category' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'changeInNetNumberSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'changeInNetSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'costOfGoodsSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'deletedCategories' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'discountSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'endTimestamp' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'exchangeAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'grossItemSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'grossModifierSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'grossProfit' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'grossProfitMargin' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'grossSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'inACategory' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'inventoryItem' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'isRevenue' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'labels' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'modifierSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netItemSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netItemSalesFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netModifierSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netModifierSalesFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netNumberSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'netSalesFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'numberSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'numExchanges' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'numNonRevenueSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'numRefunds' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'orderLevelDiscounts' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'partialRefundAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'partialRefundRepaymentAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'percentTotalNetSales' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'priceSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'refundAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'refundAmountRegardlessOfRepayment' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'refundAmountRegardlessOfRepaymentFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'refundRepaymentAmount' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'refundRepaymentAmountFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'revenueSold' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'segmentLabel' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'startTimestamp' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'totalDiscounts' field, the 'has' method for this field will now return false
Link copied to clipboard
Clears the 'totalDiscountsFractionalCents' field, the 'has' method for this field will now return false
Link copied to clipboard
Returns true if this instance has any changes.
Link copied to clipboard
Create a copy of this instance that contains only fields that were set after the constructor was called.
Link copied to clipboard
Link copied to clipboard
Net sales divided by net number sold.
Link copied to clipboard
DEPRECATED.
Link copied to clipboard
The oldest active category that the item belongs to.
Link copied to clipboard
Change in net quantity comparing the previous period to this period.
Link copied to clipboard
Change in net sales comparing the previous period to this period.
Link copied to clipboard
Cost of Goods Sold (COGS): net quantity sold multiplied by the cost.
Link copied to clipboard
DEPRECATED.
Link copied to clipboard
Link copied to clipboard
End of the time period for this summary
Link copied to clipboard
Link copied to clipboard
Item value before discounts and refunds.
Link copied to clipboard
Total value of all modifiers sold for this item.
Link copied to clipboard
Gross sales minus cost of goods sold.
Link copied to clipboard
Gross profit divided by gross sales.
Link copied to clipboard
Total value of sales of this item with modifiers before refunds and without taxes, discounts and service charges.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
True if this item should be counted as revenue.
Link copied to clipboard
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.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Total value of sales of this item after refunds and with discounts.
Link copied to clipboard
Total value of sales of this item after refunds and with discounts.
Link copied to clipboard
Total value of all modifiers sold for this item minus total value of all modifiers refunded.
Link copied to clipboard
Total value of all modifiers sold for this item minus total value of all modifiers refunded.
Link copied to clipboard
The number sold minus the number refunded and exchanged.
Link copied to clipboard
Total value of sales of this item with modifiers after refunds and with discounts.
Link copied to clipboard
Total value of sales of this item with modifiers after refunds and with discounts.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Total amount of refunds that partially refunded the item but did not fully refund the item, in units of cents.
Link copied to clipboard
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.
Link copied to clipboard
The percentage of the net sales of this item versus total net sales of all revenue items or of all non-revenue items.
Link copied to clipboard
Link copied to clipboard
Total value of items that were fully refunded.
Link copied to clipboard
Total value of items that were fully refunded.
Link copied to clipboard
Total value of items that were fully refunded.
Link copied to clipboard
Total value of items that were fully refunded and then later fully repaid.
Link copied to clipboard
Total value of items that were fully refunded and then later fully repaid.
Link copied to clipboard
This is item gross sales for line items where is_revenue=true.
Link copied to clipboard
An identifier that may be used to align report segments across different merchants.
Link copied to clipboard
Beginning of the time period for this summary
Link copied to clipboard
Total value of line item discounts and order level discounts.
Link copied to clipboard
Total value of line item discounts and order level discounts.
Link copied to clipboard
Checks whether the 'averageNetSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'categories' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'category' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'changeInNetNumberSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'changeInNetSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'costOfGoodsSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'deletedCategories' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'discountSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'endTimestamp' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'exchangeAmount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'grossItemSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'grossModifierSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'grossProfit' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'grossProfitMargin' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'grossSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'inACategory' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'inventoryItem' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'isRevenue' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'modifierSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netItemSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netItemSalesFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netModifierSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netModifierSalesFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netNumberSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'netSalesFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'numberSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'numExchanges' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'numNonRevenueSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'numRefunds' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'orderLevelDiscounts' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'partialRefundAmount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'partialRefundRepaymentAmount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'percentTotalNetSales' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'priceSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'refundAmount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'refundAmountRegardlessOfRepayment' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'refundAmountRegardlessOfRepaymentFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'refundRepaymentAmount' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'refundRepaymentAmountFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'revenueSold' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'segmentLabel' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'startTimestamp' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'totalDiscounts' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'totalDiscountsFractionalCents' field has been set, however the value could be null
Link copied to clipboard
Checks whether the 'categories' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'deletedCategories' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'discountSales' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'labels' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'modifierSales' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'orderLevelDiscounts' field is set and is not null and is not empty
Link copied to clipboard
Checks whether the 'averageNetSales' field is set and is not null
Link copied to clipboard
Checks whether the 'categories' field is set and is not null
Link copied to clipboard
Checks whether the 'category' field is set and is not null
Link copied to clipboard
Checks whether the 'changeInNetNumberSold' field is set and is not null
Link copied to clipboard
Checks whether the 'changeInNetSales' field is set and is not null
Link copied to clipboard
Checks whether the 'costOfGoodsSold' field is set and is not null
Link copied to clipboard
Checks whether the 'deletedCategories' field is set and is not null
Link copied to clipboard
Checks whether the 'discountSales' field is set and is not null
Link copied to clipboard
Checks whether the 'endTimestamp' field is set and is not null
Link copied to clipboard
Checks whether the 'exchangeAmount' field is set and is not null
Link copied to clipboard
Checks whether the 'grossItemSales' field is set and is not null
Link copied to clipboard
Checks whether the 'grossModifierSales' field is set and is not null
Link copied to clipboard
Checks whether the 'grossProfit' field is set and is not null
Link copied to clipboard
Checks whether the 'grossProfitMargin' field is set and is not null
Link copied to clipboard
Checks whether the 'grossSales' field is set and is not null
Link copied to clipboard
Checks whether the 'id' field is set and is not null
Link copied to clipboard
Checks whether the 'inACategory' field is set and is not null
Link copied to clipboard
Checks whether the 'inventoryItem' field is set and is not null
Link copied to clipboard
Checks whether the 'isRevenue' field is set and is not null
Link copied to clipboard
Checks whether the 'labels' field is set and is not null
Link copied to clipboard
Checks whether the 'modifierSales' field is set and is not null
Link copied to clipboard
Checks whether the 'name' field is set and is not null
Link copied to clipboard
Checks whether the 'netItemSales' field is set and is not null
Link copied to clipboard
Checks whether the 'netItemSalesFractionalCents' field is set and is not null
Link copied to clipboard
Checks whether the 'netModifierSales' field is set and is not null
Link copied to clipboard
Checks whether the 'netModifierSalesFractionalCents' field is set and is not null
Link copied to clipboard
Checks whether the 'netNumberSold' field is set and is not null
Link copied to clipboard
Checks whether the 'netSales' field is set and is not null
Link copied to clipboard
Checks whether the 'netSalesFractionalCents' field is set and is not null
Link copied to clipboard
Checks whether the 'numberSold' field is set and is not null
Link copied to clipboard
Checks whether the 'numExchanges' field is set and is not null
Link copied to clipboard
Checks whether the 'numNonRevenueSold' field is set and is not null
Link copied to clipboard
Checks whether the 'numRefunds' field is set and is not null
Link copied to clipboard
Checks whether the 'orderLevelDiscounts' field is set and is not null
Link copied to clipboard
Checks whether the 'partialRefundAmount' field is set and is not null
Link copied to clipboard
Checks whether the 'partialRefundRepaymentAmount' field is set and is not null
Link copied to clipboard
Checks whether the 'percentTotalNetSales' field is set and is not null
Link copied to clipboard
Checks whether the 'priceSold' field is set and is not null
Link copied to clipboard
Checks whether the 'refundAmount' field is set and is not null
Link copied to clipboard
Checks whether the 'refundAmountRegardlessOfRepayment' field is set and is not null
Link copied to clipboard
Checks whether the 'refundAmountRegardlessOfRepaymentFractionalCents' field is set and is not null
Link copied to clipboard
Checks whether the 'refundRepaymentAmount' field is set and is not null
Link copied to clipboard
Checks whether the 'refundRepaymentAmountFractionalCents' field is set and is not null
Link copied to clipboard
Checks whether the 'revenueSold' field is set and is not null
Link copied to clipboard
Checks whether the 'segmentLabel' field is set and is not null
Link copied to clipboard
Checks whether the 'startTimestamp' field is set and is not null
Link copied to clipboard
Checks whether the 'totalDiscounts' field is set and is not null
Link copied to clipboard
Checks whether the 'totalDiscountsFractionalCents' field is set and is not null
Link copied to clipboard
Copy all the changed fields from the given source to this instance.
Link copied to clipboard
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
Link copied to clipboard
Sets the field 'averageNetSales'.
Link copied to clipboard
Sets the field 'categories'.
Link copied to clipboard
Sets the field 'category'.
Link copied to clipboard
Sets the field 'changeInNetNumberSold'.
Link copied to clipboard
Sets the field 'changeInNetSales'.
Link copied to clipboard
Sets the field 'costOfGoodsSold'.
Link copied to clipboard
Sets the field 'deletedCategories'.
Link copied to clipboard
Sets the field 'discountSales'.
Link copied to clipboard
Sets the field 'endTimestamp'.
Link copied to clipboard
Sets the field 'exchangeAmount'.
Link copied to clipboard
Sets the field 'grossItemSales'.
Link copied to clipboard
Sets the field 'grossModifierSales'.
Link copied to clipboard
Sets the field 'grossProfit'.
Link copied to clipboard
Sets the field 'grossProfitMargin'.
Link copied to clipboard
Sets the field 'grossSales'.
Link copied to clipboard
Sets the field 'id'.
Link copied to clipboard
Sets the field 'inACategory'.
Link copied to clipboard
Sets the field 'inventoryItem'.
Link copied to clipboard
Sets the field 'isRevenue'.
Link copied to clipboard
Sets the field 'labels'.
Link copied to clipboard
Sets the field 'modifierSales'.
Link copied to clipboard
Sets the field 'name'.
Link copied to clipboard
Sets the field 'netItemSales'.
Link copied to clipboard
Sets the field 'netItemSalesFractionalCents'.
Link copied to clipboard
Sets the field 'netModifierSales'.
Link copied to clipboard
Sets the field 'netModifierSalesFractionalCents'.
Link copied to clipboard
Sets the field 'netNumberSold'.
Link copied to clipboard
Sets the field 'netSales'.
Link copied to clipboard
Sets the field 'netSalesFractionalCents'.
Link copied to clipboard
Sets the field 'numberSold'.
Link copied to clipboard
Sets the field 'numExchanges'.
Link copied to clipboard
Sets the field 'numNonRevenueSold'.
Link copied to clipboard
Sets the field 'numRefunds'.
Link copied to clipboard
Sets the field 'orderLevelDiscounts'.
Link copied to clipboard
Sets the field 'partialRefundAmount'.
Link copied to clipboard
Sets the field 'partialRefundRepaymentAmount'.
Link copied to clipboard
Sets the field 'percentTotalNetSales'.
Link copied to clipboard
Sets the field 'priceSold'.
Link copied to clipboard
Sets the field 'refundAmount'.
Link copied to clipboard
Sets the field 'refundAmountRegardlessOfRepayment'.
Link copied to clipboard
public ReportItem setRefundAmountRegardlessOfRepaymentFractionalCents(Double refundAmountRegardlessOfRepaymentFractionalCents)
Sets the field 'refundAmountRegardlessOfRepaymentFractionalCents'.
Link copied to clipboard
Sets the field 'refundRepaymentAmount'.
Link copied to clipboard
public ReportItem setRefundRepaymentAmountFractionalCents(Double refundRepaymentAmountFractionalCents)
Sets the field 'refundRepaymentAmountFractionalCents'.
Link copied to clipboard
Sets the field 'revenueSold'.
Link copied to clipboard
Sets the field 'segmentLabel'.
Link copied to clipboard
Sets the field 'startTimestamp'.
Link copied to clipboard
Sets the field 'totalDiscounts'.
Link copied to clipboard
Sets the field 'totalDiscountsFractionalCents'.
Link copied to clipboard