com.squareup.square.models

Class CashDrawerShift

java.lang.Object

com.squareup.square.models.CashDrawerShift

public class CashDrawerShift
extends Object

This is a model class for CashDrawerShift type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CashDrawerShift.Builder Class to build instances of CashDrawerShift.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CashDrawerShift(String id, String state, io.apimatic.core.types.OptionalNullable<String> openedAt, io.apimatic.core.types.OptionalNullable<String> endedAt, io.apimatic.core.types.OptionalNullable<String> closedAt, io.apimatic.core.types.OptionalNullable<String> description, Money openedCashMoney, Money cashPaymentMoney, Money cashRefundsMoney, Money cashPaidInMoney, Money cashPaidOutMoney, Money expectedCashMoney, Money closedCashMoney, CashDrawerDevice device, String createdAt, String updatedAt, String locationId, List<String> teamMemberIds, String openingTeamMemberId, String endingTeamMemberId, String closingTeamMemberId) Internal initialization constructor.
	CashDrawerShift(String id, String state, String openedAt, String endedAt, String closedAt, String description, Money openedCashMoney, Money cashPaymentMoney, Money cashRefundsMoney, Money cashPaidInMoney, Money cashPaidOutMoney, Money expectedCashMoney, Money closedCashMoney, CashDrawerDevice device, String createdAt, String updatedAt, String locationId, List<String> teamMemberIds, String openingTeamMemberId, String endingTeamMemberId, String closingTeamMemberId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Money	getCashPaidInMoney() Getter for CashPaidInMoney.
Money	getCashPaidOutMoney() Getter for CashPaidOutMoney.
Money	getCashPaymentMoney() Getter for CashPaymentMoney.
Money	getCashRefundsMoney() Getter for CashRefundsMoney.
String	getClosedAt() Getter for ClosedAt.
Money	getClosedCashMoney() Getter for ClosedCashMoney.
String	getClosingTeamMemberId() Getter for ClosingTeamMemberId.
String	getCreatedAt() Getter for CreatedAt.
String	getDescription() Getter for Description.
CashDrawerDevice	getDevice() Getter for Device.
String	getEndedAt() Getter for EndedAt.
String	getEndingTeamMemberId() Getter for EndingTeamMemberId.
Money	getExpectedCashMoney() Getter for ExpectedCashMoney.
String	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
String	getOpenedAt() Getter for OpenedAt.
Money	getOpenedCashMoney() Getter for OpenedCashMoney.
String	getOpeningTeamMemberId() Getter for OpeningTeamMemberId.
String	getState() Getter for State.
List<String>	getTeamMemberIds() Getter for TeamMemberIds.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetClosedAt() Internal Getter for ClosedAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetDescription() Internal Getter for Description.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEndedAt() Internal Getter for EndedAt.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetOpenedAt() Internal Getter for OpenedAt.
CashDrawerShift.Builder	toBuilder() Builds a new CashDrawerShift.Builder object.
String	toString() Converts this CashDrawerShift into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CashDrawerShift

public CashDrawerShift(String id,
                       String state,
                       String openedAt,
                       String endedAt,
                       String closedAt,
                       String description,
                       Money openedCashMoney,
                       Money cashPaymentMoney,
                       Money cashRefundsMoney,
                       Money cashPaidInMoney,
                       Money cashPaidOutMoney,
                       Money expectedCashMoney,
                       Money closedCashMoney,
                       CashDrawerDevice device,
                       String createdAt,
                       String updatedAt,
                       String locationId,
                       List<String> teamMemberIds,
                       String openingTeamMemberId,
                       String endingTeamMemberId,
                       String closingTeamMemberId)

Initialization constructor.

Parameters:

id - String value for id.

state - String value for state.

openedAt - String value for openedAt.

endedAt - String value for endedAt.

closedAt - String value for closedAt.

description - String value for description.

openedCashMoney - Money value for openedCashMoney.

cashPaymentMoney - Money value for cashPaymentMoney.

cashRefundsMoney - Money value for cashRefundsMoney.

cashPaidInMoney - Money value for cashPaidInMoney.

cashPaidOutMoney - Money value for cashPaidOutMoney.

expectedCashMoney - Money value for expectedCashMoney.

closedCashMoney - Money value for closedCashMoney.

device - CashDrawerDevice value for device.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

locationId - String value for locationId.

teamMemberIds - List of String value for teamMemberIds.

openingTeamMemberId - String value for openingTeamMemberId.

endingTeamMemberId - String value for endingTeamMemberId.

closingTeamMemberId - String value for closingTeamMemberId.

CashDrawerShift

protected CashDrawerShift(String id,
                          String state,
                          io.apimatic.core.types.OptionalNullable<String> openedAt,
                          io.apimatic.core.types.OptionalNullable<String> endedAt,
                          io.apimatic.core.types.OptionalNullable<String> closedAt,
                          io.apimatic.core.types.OptionalNullable<String> description,
                          Money openedCashMoney,
                          Money cashPaymentMoney,
                          Money cashRefundsMoney,
                          Money cashPaidInMoney,
                          Money cashPaidOutMoney,
                          Money expectedCashMoney,
                          Money closedCashMoney,
                          CashDrawerDevice device,
                          String createdAt,
                          String updatedAt,
                          String locationId,
                          List<String> teamMemberIds,
                          String openingTeamMemberId,
                          String endingTeamMemberId,
                          String closingTeamMemberId)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. The shift unique ID.

Returns:

Returns the String

getState

public String getState()

Getter for State. The current state of a cash drawer shift.

Returns:

Returns the String

internalGetOpenedAt

protected io.apimatic.core.types.OptionalNullable<String> internalGetOpenedAt()

Internal Getter for OpenedAt. The time when the shift began, in ISO 8601 format.

Returns:

Returns the Internal String

getOpenedAt

public String getOpenedAt()

Getter for OpenedAt. The time when the shift began, in ISO 8601 format.

Returns:

Returns the String

internalGetEndedAt

protected io.apimatic.core.types.OptionalNullable<String> internalGetEndedAt()

Internal Getter for EndedAt. The time when the shift ended, in ISO 8601 format.

Returns:

Returns the Internal String

getEndedAt

public String getEndedAt()

Getter for EndedAt. The time when the shift ended, in ISO 8601 format.

Returns:

Returns the String

internalGetClosedAt

protected io.apimatic.core.types.OptionalNullable<String> internalGetClosedAt()

Internal Getter for ClosedAt. The time when the shift was closed, in ISO 8601 format.

Returns:

Returns the Internal String

getClosedAt

public String getClosedAt()

Getter for ClosedAt. The time when the shift was closed, in ISO 8601 format.

Returns:

Returns the String

internalGetDescription

protected io.apimatic.core.types.OptionalNullable<String> internalGetDescription()

Internal Getter for Description. The free-form text description of a cash drawer by an employee.

Returns:

Returns the Internal String

getDescription

public String getDescription()

Getter for Description. The free-form text description of a cash drawer by an employee.

Returns:

Returns the String

getOpenedCashMoney

public Money getOpenedCashMoney()

Getter for OpenedCashMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getCashPaymentMoney

public Money getCashPaymentMoney()

Getter for CashPaymentMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getCashRefundsMoney

public Money getCashRefundsMoney()

Getter for CashRefundsMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getCashPaidInMoney

public Money getCashPaidInMoney()

Getter for CashPaidInMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getCashPaidOutMoney

public Money getCashPaidOutMoney()

Getter for CashPaidOutMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getExpectedCashMoney

public Money getExpectedCashMoney()

Getter for ExpectedCashMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getClosedCashMoney

public Money getClosedCashMoney()

Getter for ClosedCashMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getDevice

public CashDrawerDevice getDevice()

Getter for Device.

Returns:

Returns the CashDrawerDevice

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The shift start time in RFC 3339 format.

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The shift updated at time in RFC 3339 format.

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location the cash drawer shift belongs to.

Returns:

Returns the String

getTeamMemberIds

public List<String> getTeamMemberIds()

Getter for TeamMemberIds. The IDs of all team members that were logged into Square Point of Sale at any point while the cash drawer shift was open.

Returns:

Returns the List of String

getOpeningTeamMemberId

public String getOpeningTeamMemberId()

Getter for OpeningTeamMemberId. The ID of the team member that started the cash drawer shift.

Returns:

Returns the String

getEndingTeamMemberId

public String getEndingTeamMemberId()

Getter for EndingTeamMemberId. The ID of the team member that ended the cash drawer shift.

Returns:

Returns the String

getClosingTeamMemberId

public String getClosingTeamMemberId()

Getter for ClosingTeamMemberId. The ID of the team member that closed the cash drawer shift by auditing the cash drawer contents.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CashDrawerShift into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CashDrawerShift.Builder toBuilder()

Builds a new CashDrawerShift.Builder object. Creates the instance with the state of the current model.

Returns:

a new CashDrawerShift.Builder object