com.squareup.square.models

Class InventoryPhysicalCount

java.lang.Object

com.squareup.square.models.InventoryPhysicalCount

public class InventoryPhysicalCount
extends Object

This is a model class for InventoryPhysicalCount type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
InventoryPhysicalCount(String id, String referenceId, String catalogObjectId, String catalogObjectType, String state, String locationId, String quantity, SourceApplication source, String employeeId, String teamMemberId, String occurredAt, String createdAt) 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	getId() Getter for Id.
String	getLocationId() Getter for LocationId.
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.
int	hashCode()
InventoryPhysicalCount.Builder	toBuilder() Builds a new InventoryPhysicalCount.Builder object.
String	toString() Converts this InventoryPhysicalCount into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryPhysicalCount

public InventoryPhysicalCount(String id,
                              String referenceId,
                              String catalogObjectId,
                              String catalogObjectType,
                              String state,
                              String locationId,
                              String quantity,
                              SourceApplication source,
                              String employeeId,
                              String teamMemberId,
                              String occurredAt,
                              String createdAt)

Initialization constructor.

Parameters:

id - String value for id.

referenceId - String value for referenceId.

catalogObjectId - String value for catalogObjectId.

catalogObjectType - String value for catalogObjectType.

state - String value for state.

locationId - String value for locationId.

quantity - String value for quantity.

source - SourceApplication value for source.

employeeId - String value for employeeId.

teamMemberId - String value for teamMemberId.

occurredAt - String value for occurredAt.

createdAt - String value for createdAt.

Method Detail

getId

public String getId()

Getter for Id. A unique Square-generated ID for the [InventoryPhysicalCount]($m/InventoryPhysicalCount).

Returns:

Returns the String

getReferenceId

public String getReferenceId()

Getter for ReferenceId. An optional ID provided by the application to tie the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to an external system.

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

getState

public String getState()

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

Returns:

Returns the String

getLocationId

public String getLocationId()

Getter for LocationId. The Square-generated ID of the [Location]($m/Location) where the related quantity of items is being tracked.

Returns:

Returns the String

getQuantity

public String getQuantity()

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

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 physical count.

Returns:

Returns the String

getTeamMemberId

public String getTeamMemberId()

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

Returns:

Returns the String

getOccurredAt

public String getOccurredAt()

Getter for OccurredAt. A client-generated RFC 3339-formatted timestamp that indicates when the physical count was examined. For physical count updates, 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 the physical count is received.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InventoryPhysicalCount.Builder toBuilder()

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

Returns:

a new InventoryPhysicalCount.Builder object