DeviceCashSummaryRow (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.report.DeviceCashSummaryRow

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class DeviceCashSummaryRow
extends GenericParcelable
implements Validator, JSONifiable
```
This is an auto-generated Clover data object.
Each instance of this represents a summary of cash sales, cash back tendered, cash removed and cash added to a device.

Fields

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeviceCashSummaryRow.Constraints
- Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
  JSONifiable.Creator<T>
- Nested classes/interfaces inherited from interface android.os.Parcelable
  Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DeviceCashSummaryRow.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static Parcelable.Creator<DeviceCashSummaryRow> CREATOR

static JSONifiable.Creator<DeviceCashSummaryRow> JSON_CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static Parcelable.Creator<DeviceCashSummaryRow>`	`CREATOR`
`static JSONifiable.Creator<DeviceCashSummaryRow>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DeviceCashSummaryRow()` Constructs a new empty instance.
`protected`	`DeviceCashSummaryRow(boolean noInit)` Constructs a new empty instance.
	`DeviceCashSummaryRow(DeviceCashSummaryRow src)` Constructs a new instance that is a deep copy of the source instance.
	`DeviceCashSummaryRow(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.
	`DeviceCashSummaryRow(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCashAddedAmount()` Clears the 'cashAddedAmount' field, the 'has' method for this field will now return false
`void`	`clearCashBackAmount()` Clears the 'cashBackAmount' field, the 'has' method for this field will now return false
`void`	`clearCashPaymentAmount()` Clears the 'cashPaymentAmount' field, the 'has' method for this field will now return false
`void`	`clearCashRefundedAmount()` Clears the 'cashRefundedAmount' field, the 'has' method for this field will now return false
`void`	`clearCashRemovedAmount()` Clears the 'cashRemovedAmount' field, the 'has' method for this field will now return false
`void`	`clearCashSalesAmount()` Clears the 'cashSalesAmount' field, the 'has' method for this field will now return false
`void`	`clearDevice()` Clears the 'device' field, the 'has' method for this field will now return false
`void`	`clearExpectedDeposit()` Clears the 'expectedDeposit' field, the 'has' method for this field will now return false
`void`	`clearNet()` Clears the 'net' field, the 'has' method for this field will now return false
`void`	`clearNetTips()` Clears the 'netTips' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`DeviceCashSummaryRow`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`Long`	`getCashAddedAmount()` The sum of all amounts transmitted as a cash added event.
`Long`	`getCashBackAmount()` The sum of all amounts transmitted as a cash back event.
`Long`	`getCashPaymentAmount()` The sum of all payment amounts paid with cash.
`Long`	`getCashRefundedAmount()` The sum of all cash refunds and credits.
`Long`	`getCashRemovedAmount()` The sum of all amounts transmitted as a cash removed event.
`Long`	`getCashSalesAmount()` Cash payments minus cash refunded minus cash credited.
`Reference`	`getDevice()` The device that this summary is for.
`Long`	`getExpectedDeposit()` Net minus tips.
`protected GenericClient`	`getGenericClient()`
`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.
`Long`	`getNet()` Cash sales plus cash added minus cash removed minus cash back.
`Long`	`getNetTips()` Net of tips for the reporting period as an estimate how much tips would have been paid in cash to the employees.
`boolean`	`hasCashAddedAmount()` Checks whether the 'cashAddedAmount' field has been set, however the value could be null
`boolean`	`hasCashBackAmount()` Checks whether the 'cashBackAmount' field has been set, however the value could be null
`boolean`	`hasCashPaymentAmount()` Checks whether the 'cashPaymentAmount' field has been set, however the value could be null
`boolean`	`hasCashRefundedAmount()` Checks whether the 'cashRefundedAmount' field has been set, however the value could be null
`boolean`	`hasCashRemovedAmount()` Checks whether the 'cashRemovedAmount' field has been set, however the value could be null
`boolean`	`hasCashSalesAmount()` Checks whether the 'cashSalesAmount' field has been set, however the value could be null
`boolean`	`hasDevice()` Checks whether the 'device' field has been set, however the value could be null
`boolean`	`hasExpectedDeposit()` Checks whether the 'expectedDeposit' field has been set, however the value could be null
`boolean`	`hasNet()` Checks whether the 'net' field has been set, however the value could be null
`boolean`	`hasNetTips()` Checks whether the 'netTips' field has been set, however the value could be null
`boolean`	`isNotNullCashAddedAmount()` Checks whether the 'cashAddedAmount' field is set and is not null
`boolean`	`isNotNullCashBackAmount()` Checks whether the 'cashBackAmount' field is set and is not null
`boolean`	`isNotNullCashPaymentAmount()` Checks whether the 'cashPaymentAmount' field is set and is not null
`boolean`	`isNotNullCashRefundedAmount()` Checks whether the 'cashRefundedAmount' field is set and is not null
`boolean`	`isNotNullCashRemovedAmount()` Checks whether the 'cashRemovedAmount' field is set and is not null
`boolean`	`isNotNullCashSalesAmount()` Checks whether the 'cashSalesAmount' field is set and is not null
`boolean`	`isNotNullDevice()` Checks whether the 'device' field is set and is not null
`boolean`	`isNotNullExpectedDeposit()` Checks whether the 'expectedDeposit' field is set and is not null
`boolean`	`isNotNullNet()` Checks whether the 'net' field is set and is not null
`boolean`	`isNotNullNetTips()` Checks whether the 'netTips' field is set and is not null
`void`	`mergeChanges(DeviceCashSummaryRow src)` Copy all the changed fields from the given source to this instance.
`void`	`resetChangeLog()` Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
`DeviceCashSummaryRow`	`setCashAddedAmount(Long cashAddedAmount)` Sets the field 'cashAddedAmount'.
`DeviceCashSummaryRow`	`setCashBackAmount(Long cashBackAmount)` Sets the field 'cashBackAmount'.
`DeviceCashSummaryRow`	`setCashPaymentAmount(Long cashPaymentAmount)` Sets the field 'cashPaymentAmount'.
`DeviceCashSummaryRow`	`setCashRefundedAmount(Long cashRefundedAmount)` Sets the field 'cashRefundedAmount'.
`DeviceCashSummaryRow`	`setCashRemovedAmount(Long cashRemovedAmount)` Sets the field 'cashRemovedAmount'.
`DeviceCashSummaryRow`	`setCashSalesAmount(Long cashSalesAmount)` Sets the field 'cashSalesAmount'.
`DeviceCashSummaryRow`	`setDevice(Reference device)` Sets the field 'device'.
`DeviceCashSummaryRow`	`setExpectedDeposit(Long expectedDeposit)` Sets the field 'expectedDeposit'.
`DeviceCashSummaryRow`	`setNet(Long net)` Sets the field 'net'.
`DeviceCashSummaryRow`	`setNetTips(Long netTips)` Sets the field 'netTips'.
`void`	`validate()`

Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final Parcelable.Creator<DeviceCashSummaryRow> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<DeviceCashSummaryRow> JSON_CREATOR
```
- Constructor Detail
  - DeviceCashSummaryRow
```
public DeviceCashSummaryRow()
```
    Constructs a new empty instance.
  - DeviceCashSummaryRow
```
protected DeviceCashSummaryRow(boolean noInit)
```
    Constructs a new empty instance.
  - DeviceCashSummaryRow
```
public DeviceCashSummaryRow(String json)
                     throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - DeviceCashSummaryRow
```
public DeviceCashSummaryRow(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.
  - DeviceCashSummaryRow
```
public DeviceCashSummaryRow(DeviceCashSummaryRow src)
```
    Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
- Method Detail
  - getDevice
```
public Reference getDevice()
```
    The device that this summary is for. For the total row, this field will be null. A 128-bit UUID, not a normal base-13 Clover ID.
  - getCashSalesAmount
```
public Long getCashSalesAmount()
```
    Cash payments minus cash refunded minus cash credited. A legacy field which does not represent Cash Sales in the Cash Deposit widget.
  - getCashPaymentAmount
```
public Long getCashPaymentAmount()
```
    The sum of all payment amounts paid with cash. Does not include tips. Does include tax and service charge. This gets mapped to Cash Sales in the Cash Deposit widget.
  - getCashRefundedAmount
```
public Long getCashRefundedAmount()
```
    The sum of all cash refunds and credits.
  - getCashBackAmount
```
public Long getCashBackAmount()
```
    The sum of all amounts transmitted as a cash back event. Should be the sum of all money given to customers as cash back on a debit card for merchants with Cash Log app.
  - getCashAddedAmount
```
public Long getCashAddedAmount()
```
    The sum of all amounts transmitted as a cash added event. Should be the sum of all money manually added to a cash drawer separate from a transaction by an employee for merchants with Cash Log app.
  - getCashRemovedAmount
```
public Long getCashRemovedAmount()
```
    The sum of all amounts transmitted as a cash removed event. Should be the sum of all money manually removed from a cash drawer separate from a transaction by an employee for merchants with Cash Log app.
  - getNet
```
public Long getNet()
```
    Cash sales plus cash added minus cash removed minus cash back. This is called Amount Collected in Cash Deposit Widget.
  - getNetTips
```
public Long getNetTips()
```
    Net of tips for the reporting period as an estimate how much tips would have been paid in cash to the employees. Reported as a negative number.
  - getExpectedDeposit
```
public Long getExpectedDeposit()
```
    Net minus tips.
  - getGenericClient
```
protected GenericClient getGenericClient()
```
    Specified by:
    
    getGenericClient in class GenericParcelable
  - 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
  - validate
```
public void validate()
```
    Specified by:
    
    validate in interface Validator
  - isNotNullDevice
```
public boolean isNotNullDevice()
```
    Checks whether the 'device' field is set and is not null
  - isNotNullCashSalesAmount
```
public boolean isNotNullCashSalesAmount()
```
    Checks whether the 'cashSalesAmount' field is set and is not null
  - isNotNullCashPaymentAmount
```
public boolean isNotNullCashPaymentAmount()
```
    Checks whether the 'cashPaymentAmount' field is set and is not null
  - isNotNullCashRefundedAmount
```
public boolean isNotNullCashRefundedAmount()
```
    Checks whether the 'cashRefundedAmount' field is set and is not null
  - isNotNullCashBackAmount
```
public boolean isNotNullCashBackAmount()
```
    Checks whether the 'cashBackAmount' field is set and is not null
  - isNotNullCashAddedAmount
```
public boolean isNotNullCashAddedAmount()
```
    Checks whether the 'cashAddedAmount' field is set and is not null
  - isNotNullCashRemovedAmount
```
public boolean isNotNullCashRemovedAmount()
```
    Checks whether the 'cashRemovedAmount' field is set and is not null
  - isNotNullNet
```
public boolean isNotNullNet()
```
    Checks whether the 'net' field is set and is not null
  - isNotNullNetTips
```
public boolean isNotNullNetTips()
```
    Checks whether the 'netTips' field is set and is not null
  - isNotNullExpectedDeposit
```
public boolean isNotNullExpectedDeposit()
```
    Checks whether the 'expectedDeposit' field is set and is not null
  - hasDevice
```
public boolean hasDevice()
```
    Checks whether the 'device' field has been set, however the value could be null
  - hasCashSalesAmount
```
public boolean hasCashSalesAmount()
```
    Checks whether the 'cashSalesAmount' field has been set, however the value could be null
  - hasCashPaymentAmount
```
public boolean hasCashPaymentAmount()
```
    Checks whether the 'cashPaymentAmount' field has been set, however the value could be null
  - hasCashRefundedAmount
```
public boolean hasCashRefundedAmount()
```
    Checks whether the 'cashRefundedAmount' field has been set, however the value could be null
  - hasCashBackAmount
```
public boolean hasCashBackAmount()
```
    Checks whether the 'cashBackAmount' field has been set, however the value could be null
  - hasCashAddedAmount
```
public boolean hasCashAddedAmount()
```
    Checks whether the 'cashAddedAmount' field has been set, however the value could be null
  - hasCashRemovedAmount
```
public boolean hasCashRemovedAmount()
```
    Checks whether the 'cashRemovedAmount' field has been set, however the value could be null
  - hasNet
```
public boolean hasNet()
```
    Checks whether the 'net' field has been set, however the value could be null
  - hasNetTips
```
public boolean hasNetTips()
```
    Checks whether the 'netTips' field has been set, however the value could be null
  - hasExpectedDeposit
```
public boolean hasExpectedDeposit()
```
    Checks whether the 'expectedDeposit' field has been set, however the value could be null
  - setDevice
```
public DeviceCashSummaryRow setDevice(Reference device)
```
    Sets the field 'device'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setCashSalesAmount
```
public DeviceCashSummaryRow setCashSalesAmount(Long cashSalesAmount)
```
    Sets the field 'cashSalesAmount'.
  - setCashPaymentAmount
```
public DeviceCashSummaryRow setCashPaymentAmount(Long cashPaymentAmount)
```
    Sets the field 'cashPaymentAmount'.
  - setCashRefundedAmount
```
public DeviceCashSummaryRow setCashRefundedAmount(Long cashRefundedAmount)
```
    Sets the field 'cashRefundedAmount'.
  - setCashBackAmount
```
public DeviceCashSummaryRow setCashBackAmount(Long cashBackAmount)
```
    Sets the field 'cashBackAmount'.
  - setCashAddedAmount
```
public DeviceCashSummaryRow setCashAddedAmount(Long cashAddedAmount)
```
    Sets the field 'cashAddedAmount'.
  - setCashRemovedAmount
```
public DeviceCashSummaryRow setCashRemovedAmount(Long cashRemovedAmount)
```
    Sets the field 'cashRemovedAmount'.
  - setNet
```
public DeviceCashSummaryRow setNet(Long net)
```
    Sets the field 'net'.
  - setNetTips
```
public DeviceCashSummaryRow setNetTips(Long netTips)
```
    Sets the field 'netTips'.
  - setExpectedDeposit
```
public DeviceCashSummaryRow setExpectedDeposit(Long expectedDeposit)
```
    Sets the field 'expectedDeposit'.
  - clearDevice
```
public void clearDevice()
```
    Clears the 'device' field, the 'has' method for this field will now return false
  - clearCashSalesAmount
```
public void clearCashSalesAmount()
```
    Clears the 'cashSalesAmount' field, the 'has' method for this field will now return false
  - clearCashPaymentAmount
```
public void clearCashPaymentAmount()
```
    Clears the 'cashPaymentAmount' field, the 'has' method for this field will now return false
  - clearCashRefundedAmount
```
public void clearCashRefundedAmount()
```
    Clears the 'cashRefundedAmount' field, the 'has' method for this field will now return false
  - clearCashBackAmount
```
public void clearCashBackAmount()
```
    Clears the 'cashBackAmount' field, the 'has' method for this field will now return false
  - clearCashAddedAmount
```
public void clearCashAddedAmount()
```
    Clears the 'cashAddedAmount' field, the 'has' method for this field will now return false
  - clearCashRemovedAmount
```
public void clearCashRemovedAmount()
```
    Clears the 'cashRemovedAmount' field, the 'has' method for this field will now return false
  - clearNet
```
public void clearNet()
```
    Clears the 'net' field, the 'has' method for this field will now return false
  - clearNetTips
```
public void clearNetTips()
```
    Clears the 'netTips' field, the 'has' method for this field will now return false
  - clearExpectedDeposit
```
public void clearExpectedDeposit()
```
    Clears the 'expectedDeposit' 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 DeviceCashSummaryRow copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(DeviceCashSummaryRow src)
```
    Copy all the changed fields from the given source to this instance.

Class DeviceCashSummaryRow

Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.clover.sdk.GenericParcelable

Methods inherited from class java.lang.Object

Field Detail

CREATOR

JSON_CREATOR

Constructor Detail

DeviceCashSummaryRow

DeviceCashSummaryRow

DeviceCashSummaryRow

DeviceCashSummaryRow

DeviceCashSummaryRow

Method Detail

getDevice

getCashSalesAmount

getCashPaymentAmount

getCashRefundedAmount

getCashBackAmount

getCashAddedAmount

getCashRemovedAmount

getNet

getNetTips

getExpectedDeposit

getGenericClient

getJSONObject

validate

isNotNullDevice

isNotNullCashSalesAmount

isNotNullCashPaymentAmount

isNotNullCashRefundedAmount

isNotNullCashBackAmount

isNotNullCashAddedAmount

isNotNullCashRemovedAmount

isNotNullNet

isNotNullNetTips

isNotNullExpectedDeposit

hasDevice

hasCashSalesAmount

hasCashPaymentAmount

hasCashRefundedAmount

hasCashBackAmount

hasCashAddedAmount

hasCashRemovedAmount

hasNet

hasNetTips

hasExpectedDeposit

setDevice

setCashSalesAmount

setCashPaymentAmount

setCashRefundedAmount

setCashBackAmount

setCashAddedAmount

setCashRemovedAmount

setNet

setNetTips

setExpectedDeposit

clearDevice

clearCashSalesAmount

clearCashPaymentAmount

clearCashRefundedAmount

clearCashBackAmount

clearCashAddedAmount

clearCashRemovedAmount

clearNet

clearNetTips

clearExpectedDeposit

containsChanges

resetChangeLog

copyChanges

mergeChanges