com.squareup.square.models

Class InventoryTransfer

java.lang.Object

com.squareup.square.models.InventoryTransfer

public class InventoryTransfer
extends Object

This is a model class for InventoryTransfer type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
InventoryTransfer(String id, String referenceId, String state, String fromLocationId, String toLocationId, String catalogObjectId, String catalogObjectType, String quantity, String occurredAt, String createdAt, SourceApplication source, String employeeId, String teamMemberId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCatalogObjectId() Getter for CatalogObjectId.
String	getCatalogObjectType() Getter for CatalogObjectType.
String	getCreatedAt() Getter for CreatedAt.
String	getEmployeeId() Getter for EmployeeId.
String	getFromLocationId() Getter for FromLocationId.
String	getId() Getter for Id.
String	getOccurredAt() Getter for OccurredAt.
String	getQuantity() Getter for Quantity.
String	getReferenceId() Getter for ReferenceId.
SourceApplication	getSource() Getter for Source.
String	getState() Getter for State.
String	getTeamMemberId() Getter for TeamMemberId.
String	getToLocationId() Getter for ToLocationId.
int	hashCode()
InventoryTransfer.Builder	toBuilder() Builds a new InventoryTransfer.Builder object.
String	toString() Converts this InventoryTransfer into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryTransfer

public InventoryTransfer(String id,
                         String referenceId,
                         String state,
                         String fromLocationId,
                         String toLocationId,
                         String catalogObjectId,
                         String catalogObjectType,
                         String quantity,
                         String occurredAt,
                         String createdAt,
                         SourceApplication source,
                         String employeeId,
                         String teamMemberId)

Initialization constructor.

Parameters:

id - String value for id.

referenceId - String value for referenceId.

state - String value for state.

fromLocationId - String value for fromLocationId.

toLocationId - String value for toLocationId.

catalogObjectId - String value for catalogObjectId.

catalogObjectType - String value for catalogObjectType.

quantity - String value for quantity.

occurredAt - String value for occurredAt.

createdAt - String value for createdAt.

source - SourceApplication value for source.

employeeId - String value for employeeId.

teamMemberId - String value for teamMemberId.

Method Detail

getId

public String getId()

Getter for Id. A unique ID generated by Square for the `InventoryTransfer`.

Returns:

Returns the String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. An optional ID provided by the application to tie the `InventoryTransfer` to an external system.

Returns:

Returns the String

getState

public String getState()

Getter for State. Indicates the state of a tracked item quantity in the lifecycle of goods.

Returns:

Returns the String

getFromLocationId

public String getFromLocationId()

Getter for FromLocationId. The Square-generated ID of the [Location]($m/Location) where the related quantity of items was tracked before the transfer.

Returns:

Returns the String

getToLocationId

public String getToLocationId()

Getter for ToLocationId. The Square-generated ID of the [Location]($m/Location) where the related quantity of items was tracked after the transfer.

Returns:

Returns the String

getCatalogObjectId

public String getCatalogObjectId()

Getter for CatalogObjectId. The Square-generated ID of the [CatalogObject]($m/CatalogObject) being tracked.

Returns:

Returns the String

getCatalogObjectType

public String getCatalogObjectType()

Getter for CatalogObjectType. The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value. In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.

Returns:

Returns the String

getQuantity

public String getQuantity()

Getter for Quantity. The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point.

Returns:

Returns the String

getOccurredAt

public String getOccurredAt()

Getter for OccurredAt. A client-generated RFC 3339-formatted timestamp that indicates when the transfer took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. An RFC 3339-formatted timestamp that indicates when Square received the transfer request.

Returns:

Returns the String

getSource

public SourceApplication getSource()

Getter for Source. Represents information about the application used to generate a change.

Returns:

Returns the SourceApplication

getEmployeeId

public String getEmployeeId()

Getter for EmployeeId. The Square-generated ID of the [Employee]($m/Employee) responsible for the inventory transfer.

Returns:

Returns the String

getTeamMemberId

public String getTeamMemberId()

Getter for TeamMemberId. The Square-generated ID of the [Team Member]($m/TeamMember) responsible for the inventory transfer.

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 InventoryTransfer into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InventoryTransfer.Builder toBuilder()

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

Returns:

a new InventoryTransfer.Builder object