Package com.clover.sdk.v3.report
Class ReportPaymentsV2Row
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.report.ReportPaymentsV2Row
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class ReportPaymentsV2Row extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Each instance of this represents a payment summary, a tender stats, a card type, or a DCC row in the payments report summary table. Only a subset of fields are populated in each section.
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ReportPaymentsV2Row.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 extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<ReportPaymentsV2Row>
CREATOR
static JSONifiable.Creator<ReportPaymentsV2Row>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description ReportPaymentsV2Row()
Constructs a new empty instance.protected
ReportPaymentsV2Row(boolean noInit)
Constructs a new empty instance.ReportPaymentsV2Row(ReportPaymentsV2Row src)
Constructs a new instance that is a deep copy of the source instance.ReportPaymentsV2Row(String json)
Constructs a new instance from the given JSON String.ReportPaymentsV2Row(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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearCreditAmount()
Clears the 'creditAmount' field, the 'has' method for this field will now return falsevoid
clearName()
Clears the 'name' field, the 'has' method for this field will now return falsevoid
clearNet()
Clears the 'net' field, the 'has' method for this field will now return falsevoid
clearNumTransactions()
Clears the 'numTransactions' field, the 'has' method for this field will now return falsevoid
clearPaymentAmount()
Clears the 'paymentAmount' field, the 'has' method for this field will now return falsevoid
clearRefundAmount()
Clears the 'refundAmount' field, the 'has' method for this field will now return falsevoid
clearRefundAndCreditAmount()
Clears the 'refundAndCreditAmount' field, the 'has' method for this field will now return falsevoid
clearRefundTipAmount()
Clears the 'refundTipAmount' field, the 'has' method for this field will now return falsevoid
clearRevenueAmount()
Clears the 'revenueAmount' field, the 'has' method for this field will now return falsevoid
clearServiceChargeAmount()
Clears the 'serviceChargeAmount' field, the 'has' method for this field will now return falsevoid
clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return falsevoid
clearTender()
Clears the 'tender' field, the 'has' method for this field will now return falsevoid
clearTipAmount()
Clears the 'tipAmount' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.ReportPaymentsV2Row
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.Long
getCreditAmount()
Total amount of manual refunds.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.String
getName()
The name of the row, like Gross Online Payments, Credit Card, Master Card, etc.Long
getNet()
Revenue plus tax plus tips minus refunds minus manual refunds.Long
getNumTransactions()
Total number of transactions of this type.Long
getPaymentAmount()
Revenue plus tax.Long
getRefundAmount()
Total amount of refunds.Long
getRefundAndCreditAmount()
Total amount of refunds and manual refunds.Long
getRefundTipAmount()
Amount of tip that was refunded.Long
getRevenueAmount()
Revenue includes service charge.Long
getServiceChargeAmount()
Total amount of service charges.Long
getTaxAmount()
Total amount of taxes collected.Tender
getTender()
For card type sales, this is the parent tender type that this card type belongs to.Long
getTipAmount()
Total amount of tips.boolean
hasCreditAmount()
Checks whether the 'creditAmount' field has been set, however the value could be nullboolean
hasName()
Checks whether the 'name' field has been set, however the value could be nullboolean
hasNet()
Checks whether the 'net' field has been set, however the value could be nullboolean
hasNumTransactions()
Checks whether the 'numTransactions' field has been set, however the value could be nullboolean
hasPaymentAmount()
Checks whether the 'paymentAmount' field has been set, however the value could be nullboolean
hasRefundAmount()
Checks whether the 'refundAmount' field has been set, however the value could be nullboolean
hasRefundAndCreditAmount()
Checks whether the 'refundAndCreditAmount' field has been set, however the value could be nullboolean
hasRefundTipAmount()
Checks whether the 'refundTipAmount' field has been set, however the value could be nullboolean
hasRevenueAmount()
Checks whether the 'revenueAmount' field has been set, however the value could be nullboolean
hasServiceChargeAmount()
Checks whether the 'serviceChargeAmount' field has been set, however the value could be nullboolean
hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be nullboolean
hasTender()
Checks whether the 'tender' field has been set, however the value could be nullboolean
hasTipAmount()
Checks whether the 'tipAmount' field has been set, however the value could be nullboolean
isNotNullCreditAmount()
Checks whether the 'creditAmount' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullNet()
Checks whether the 'net' field is set and is not nullboolean
isNotNullNumTransactions()
Checks whether the 'numTransactions' field is set and is not nullboolean
isNotNullPaymentAmount()
Checks whether the 'paymentAmount' field is set and is not nullboolean
isNotNullRefundAmount()
Checks whether the 'refundAmount' field is set and is not nullboolean
isNotNullRefundAndCreditAmount()
Checks whether the 'refundAndCreditAmount' field is set and is not nullboolean
isNotNullRefundTipAmount()
Checks whether the 'refundTipAmount' field is set and is not nullboolean
isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not nullboolean
isNotNullServiceChargeAmount()
Checks whether the 'serviceChargeAmount' field is set and is not nullboolean
isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not nullboolean
isNotNullTender()
Checks whether the 'tender' field is set and is not nullboolean
isNotNullTipAmount()
Checks whether the 'tipAmount' field is set and is not nullvoid
mergeChanges(ReportPaymentsV2Row 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.ReportPaymentsV2Row
setCreditAmount(Long creditAmount)
Sets the field 'creditAmount'.ReportPaymentsV2Row
setName(String name)
Sets the field 'name'.ReportPaymentsV2Row
setNet(Long net)
Sets the field 'net'.ReportPaymentsV2Row
setNumTransactions(Long numTransactions)
Sets the field 'numTransactions'.ReportPaymentsV2Row
setPaymentAmount(Long paymentAmount)
Sets the field 'paymentAmount'.ReportPaymentsV2Row
setRefundAmount(Long refundAmount)
Sets the field 'refundAmount'.ReportPaymentsV2Row
setRefundAndCreditAmount(Long refundAndCreditAmount)
Sets the field 'refundAndCreditAmount'.ReportPaymentsV2Row
setRefundTipAmount(Long refundTipAmount)
Sets the field 'refundTipAmount'.ReportPaymentsV2Row
setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.ReportPaymentsV2Row
setServiceChargeAmount(Long serviceChargeAmount)
Sets the field 'serviceChargeAmount'.ReportPaymentsV2Row
setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.ReportPaymentsV2Row
setTender(Tender tender)
Sets the field 'tender'.ReportPaymentsV2Row
setTipAmount(Long tipAmount)
Sets the field 'tipAmount'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<ReportPaymentsV2Row> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<ReportPaymentsV2Row> JSON_CREATOR
-
-
Constructor Detail
-
ReportPaymentsV2Row
public ReportPaymentsV2Row()
Constructs a new empty instance.
-
ReportPaymentsV2Row
protected ReportPaymentsV2Row(boolean noInit)
Constructs a new empty instance.
-
ReportPaymentsV2Row
public ReportPaymentsV2Row(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
ReportPaymentsV2Row
public ReportPaymentsV2Row(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.
-
ReportPaymentsV2Row
public ReportPaymentsV2Row(ReportPaymentsV2Row src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getName
public String getName()
The name of the row, like Gross Online Payments, Credit Card, Master Card, etc.
-
getNumTransactions
public Long getNumTransactions()
Total number of transactions of this type.
-
getNet
public Long getNet()
Revenue plus tax plus tips minus refunds minus manual refunds. Revenue includes service charge.
-
getPaymentAmount
public Long getPaymentAmount()
Revenue plus tax. Revenue includes service charge. Does not include tips except in the tenders section of the legacy payments report when it does include tip.
-
getRevenueAmount
public Long getRevenueAmount()
Revenue includes service charge. It does not include either tax or tip.
-
getTaxAmount
public Long getTaxAmount()
Total amount of taxes collected.
-
getTipAmount
public Long getTipAmount()
Total amount of tips.
-
getRefundTipAmount
public Long getRefundTipAmount()
Amount of tip that was refunded.
-
getServiceChargeAmount
public Long getServiceChargeAmount()
Total amount of service charges. This is included in revenue.
-
getRefundAmount
public Long getRefundAmount()
Total amount of refunds. This amount includes tax, tip and service charge.
-
getCreditAmount
public Long getCreditAmount()
Total amount of manual refunds. This amount includes tax.
-
getRefundAndCreditAmount
public Long getRefundAndCreditAmount()
Total amount of refunds and manual refunds. This amount includes tax, tip and service charge.
-
getTender
public Tender getTender()
For card type sales, this is the parent tender type that this card type belongs to.
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
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 interfaceJSONifiable
-
isNotNullName
public boolean isNotNullName()
Checks whether the 'name' field is set and is not null
-
isNotNullNumTransactions
public boolean isNotNullNumTransactions()
Checks whether the 'numTransactions' field is set and is not null
-
isNotNullNet
public boolean isNotNullNet()
Checks whether the 'net' field is set and is not null
-
isNotNullPaymentAmount
public boolean isNotNullPaymentAmount()
Checks whether the 'paymentAmount' field is set and is not null
-
isNotNullRevenueAmount
public boolean isNotNullRevenueAmount()
Checks whether the 'revenueAmount' field is set and is not null
-
isNotNullTaxAmount
public boolean isNotNullTaxAmount()
Checks whether the 'taxAmount' field is set and is not null
-
isNotNullTipAmount
public boolean isNotNullTipAmount()
Checks whether the 'tipAmount' field is set and is not null
-
isNotNullRefundTipAmount
public boolean isNotNullRefundTipAmount()
Checks whether the 'refundTipAmount' field is set and is not null
-
isNotNullServiceChargeAmount
public boolean isNotNullServiceChargeAmount()
Checks whether the 'serviceChargeAmount' field is set and is not null
-
isNotNullRefundAmount
public boolean isNotNullRefundAmount()
Checks whether the 'refundAmount' field is set and is not null
-
isNotNullCreditAmount
public boolean isNotNullCreditAmount()
Checks whether the 'creditAmount' field is set and is not null
-
isNotNullRefundAndCreditAmount
public boolean isNotNullRefundAndCreditAmount()
Checks whether the 'refundAndCreditAmount' field is set and is not null
-
isNotNullTender
public boolean isNotNullTender()
Checks whether the 'tender' field is set and is not null
-
hasName
public boolean hasName()
Checks whether the 'name' field has been set, however the value could be null
-
hasNumTransactions
public boolean hasNumTransactions()
Checks whether the 'numTransactions' 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
-
hasPaymentAmount
public boolean hasPaymentAmount()
Checks whether the 'paymentAmount' field has been set, however the value could be null
-
hasRevenueAmount
public boolean hasRevenueAmount()
Checks whether the 'revenueAmount' field has been set, however the value could be null
-
hasTaxAmount
public boolean hasTaxAmount()
Checks whether the 'taxAmount' field has been set, however the value could be null
-
hasTipAmount
public boolean hasTipAmount()
Checks whether the 'tipAmount' field has been set, however the value could be null
-
hasRefundTipAmount
public boolean hasRefundTipAmount()
Checks whether the 'refundTipAmount' field has been set, however the value could be null
-
hasServiceChargeAmount
public boolean hasServiceChargeAmount()
Checks whether the 'serviceChargeAmount' 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
-
hasCreditAmount
public boolean hasCreditAmount()
Checks whether the 'creditAmount' field has been set, however the value could be null
-
hasRefundAndCreditAmount
public boolean hasRefundAndCreditAmount()
Checks whether the 'refundAndCreditAmount' field has been set, however the value could be null
-
hasTender
public boolean hasTender()
Checks whether the 'tender' field has been set, however the value could be null
-
setName
public ReportPaymentsV2Row setName(String name)
Sets the field 'name'.
-
setNumTransactions
public ReportPaymentsV2Row setNumTransactions(Long numTransactions)
Sets the field 'numTransactions'.
-
setNet
public ReportPaymentsV2Row setNet(Long net)
Sets the field 'net'.
-
setPaymentAmount
public ReportPaymentsV2Row setPaymentAmount(Long paymentAmount)
Sets the field 'paymentAmount'.
-
setRevenueAmount
public ReportPaymentsV2Row setRevenueAmount(Long revenueAmount)
Sets the field 'revenueAmount'.
-
setTaxAmount
public ReportPaymentsV2Row setTaxAmount(Long taxAmount)
Sets the field 'taxAmount'.
-
setTipAmount
public ReportPaymentsV2Row setTipAmount(Long tipAmount)
Sets the field 'tipAmount'.
-
setRefundTipAmount
public ReportPaymentsV2Row setRefundTipAmount(Long refundTipAmount)
Sets the field 'refundTipAmount'.
-
setServiceChargeAmount
public ReportPaymentsV2Row setServiceChargeAmount(Long serviceChargeAmount)
Sets the field 'serviceChargeAmount'.
-
setRefundAmount
public ReportPaymentsV2Row setRefundAmount(Long refundAmount)
Sets the field 'refundAmount'.
-
setCreditAmount
public ReportPaymentsV2Row setCreditAmount(Long creditAmount)
Sets the field 'creditAmount'.
-
setRefundAndCreditAmount
public ReportPaymentsV2Row setRefundAndCreditAmount(Long refundAndCreditAmount)
Sets the field 'refundAndCreditAmount'.
-
setTender
public ReportPaymentsV2Row setTender(Tender tender)
Sets the field 'tender'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
clearName
public void clearName()
Clears the 'name' field, the 'has' method for this field will now return false
-
clearNumTransactions
public void clearNumTransactions()
Clears the 'numTransactions' 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
-
clearPaymentAmount
public void clearPaymentAmount()
Clears the 'paymentAmount' field, the 'has' method for this field will now return false
-
clearRevenueAmount
public void clearRevenueAmount()
Clears the 'revenueAmount' field, the 'has' method for this field will now return false
-
clearTaxAmount
public void clearTaxAmount()
Clears the 'taxAmount' field, the 'has' method for this field will now return false
-
clearTipAmount
public void clearTipAmount()
Clears the 'tipAmount' field, the 'has' method for this field will now return false
-
clearRefundTipAmount
public void clearRefundTipAmount()
Clears the 'refundTipAmount' field, the 'has' method for this field will now return false
-
clearServiceChargeAmount
public void clearServiceChargeAmount()
Clears the 'serviceChargeAmount' 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
-
clearCreditAmount
public void clearCreditAmount()
Clears the 'creditAmount' field, the 'has' method for this field will now return false
-
clearRefundAndCreditAmount
public void clearRefundAndCreditAmount()
Clears the 'refundAndCreditAmount' field, the 'has' method for this field will now return false
-
clearTender
public void clearTender()
Clears the 'tender' 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 ReportPaymentsV2Row copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(ReportPaymentsV2Row src)
Copy all the changed fields from the given source to this instance.
-
-