CashDrawerShift (Square 20.0.0.20220512 API)

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.

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

Constructor Summary

Constructors
Constructor and Description
`CashDrawerShift(String id, String state, String openedAt, String endedAt, String closedAt, List<String> employeeIds, String openingEmployeeId, String endingEmployeeId, String closingEmployeeId, String description, Money openedCashMoney, Money cashPaymentMoney, Money cashRefundsMoney, Money cashPaidInMoney, Money cashPaidOutMoney, Money expectedCashMoney, Money closedCashMoney, CashDrawerDevice device)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getClosingEmployeeId()` Getter for ClosingEmployeeId.
`String`	`getDescription()` Getter for Description.
`CashDrawerDevice`	`getDevice()` Getter for Device.
`List<String>`	`getEmployeeIds()` Getter for EmployeeIds.
`String`	`getEndedAt()` Getter for EndedAt.
`String`	`getEndingEmployeeId()` Getter for EndingEmployeeId.
`Money`	`getExpectedCashMoney()` Getter for ExpectedCashMoney.
`String`	`getId()` Getter for Id.
`String`	`getOpenedAt()` Getter for OpenedAt.
`Money`	`getOpenedCashMoney()` Getter for OpenedCashMoney.
`String`	`getOpeningEmployeeId()` Getter for OpeningEmployeeId.
`String`	`getState()` Getter for State.
`int`	`hashCode()`
`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,
                       List<String> employeeIds,
                       String openingEmployeeId,
                       String endingEmployeeId,
                       String closingEmployeeId,
                       String description,
                       Money openedCashMoney,
                       Money cashPaymentMoney,
                       Money cashRefundsMoney,
                       Money cashPaidInMoney,
                       Money cashPaidOutMoney,
                       Money expectedCashMoney,
                       Money closedCashMoney,
                       CashDrawerDevice device)
```
    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.
    
    employeeIds - List of String value for employeeIds.
    
    openingEmployeeId - String value for openingEmployeeId.
    
    endingEmployeeId - String value for endingEmployeeId.
    
    closingEmployeeId - String value for closingEmployeeId.
    
    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.
- 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
  - getOpenedAt
```
public String getOpenedAt()
```
    Getter for OpenedAt. The time when the shift began, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - getEndedAt
```
public String getEndedAt()
```
    Getter for EndedAt. The time when the shift ended, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - getClosedAt
```
public String getClosedAt()
```
    Getter for ClosedAt. The time when the shift was closed, in ISO 8601 format.
    
    Returns:
    
    Returns the String
  - getEmployeeIds
```
public List<String> getEmployeeIds()
```
    Getter for EmployeeIds. The IDs of all employees that were logged into Square Point of Sale at any point while the cash drawer shift was open.
    
    Returns:
    
    Returns the List of String
  - getOpeningEmployeeId
```
public String getOpeningEmployeeId()
```
    Getter for OpeningEmployeeId. The ID of the employee that started the cash drawer shift.
    
    Returns:
    
    Returns the String
  - getEndingEmployeeId
```
public String getEndingEmployeeId()
```
    Getter for EndingEmployeeId. The ID of the employee that ended the cash drawer shift.
    
    Returns:
    
    Returns the String
  - getClosingEmployeeId
```
public String getClosingEmployeeId()
```
    Getter for ClosingEmployeeId. The ID of the employee that closed the cash drawer shift by auditing the cash drawer contents.
    
    Returns:
    
    Returns the 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
  - 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

Class CashDrawerShift

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CashDrawerShift

Method Detail

getId

getState

getOpenedAt

getEndedAt

getClosedAt

getEmployeeIds

getOpeningEmployeeId

getEndingEmployeeId

getClosingEmployeeId

getDescription

getOpenedCashMoney

getCashPaymentMoney

getCashRefundsMoney

getCashPaidInMoney

getCashPaidOutMoney

getExpectedCashMoney

getClosedCashMoney

getDevice

hashCode

equals

toString

toBuilder