InventoryAdjustment (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.InventoryAdjustment

```
public class InventoryAdjustment
extends Object
```
This is a model class for InventoryAdjustment type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InventoryAdjustment.Builder
Class to build instances of InventoryAdjustment.

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

Constructor Summary

Constructors
Constructor and Description
`InventoryAdjustment(String id, String referenceId, String fromState, String toState, String locationId, String catalogObjectId, String catalogObjectType, String quantity, Money totalPriceMoney, String occurredAt, String createdAt, SourceApplication source, String employeeId, String teamMemberId, String transactionId, String refundId, String purchaseOrderId, String goodsReceiptId, InventoryAdjustmentGroup adjustmentGroup)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`InventoryAdjustmentGroup`	`getAdjustmentGroup()` Getter for AdjustmentGroup.
`String`	`getCatalogObjectId()` Getter for CatalogObjectId.
`String`	`getCatalogObjectType()` Getter for CatalogObjectType.
`String`	`getCreatedAt()` Getter for CreatedAt.
`String`	`getEmployeeId()` Getter for EmployeeId.
`String`	`getFromState()` Getter for FromState.
`String`	`getGoodsReceiptId()` Getter for GoodsReceiptId.
`String`	`getId()` Getter for Id.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getOccurredAt()` Getter for OccurredAt.
`String`	`getPurchaseOrderId()` Getter for PurchaseOrderId.
`String`	`getQuantity()` Getter for Quantity.
`String`	`getReferenceId()` Getter for ReferenceId.
`String`	`getRefundId()` Getter for RefundId.
`SourceApplication`	`getSource()` Getter for Source.
`String`	`getTeamMemberId()` Getter for TeamMemberId.
`String`	`getToState()` Getter for ToState.
`Money`	`getTotalPriceMoney()` Getter for TotalPriceMoney.
`String`	`getTransactionId()` Getter for TransactionId.
`int`	`hashCode()`
`InventoryAdjustment.Builder`	`toBuilder()` Builds a new `InventoryAdjustment.Builder` object.
`String`	`toString()` Converts this InventoryAdjustment into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InventoryAdjustment
```
public InventoryAdjustment(String id,
                           String referenceId,
                           String fromState,
                           String toState,
                           String locationId,
                           String catalogObjectId,
                           String catalogObjectType,
                           String quantity,
                           Money totalPriceMoney,
                           String occurredAt,
                           String createdAt,
                           SourceApplication source,
                           String employeeId,
                           String teamMemberId,
                           String transactionId,
                           String refundId,
                           String purchaseOrderId,
                           String goodsReceiptId,
                           InventoryAdjustmentGroup adjustmentGroup)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    referenceId - String value for referenceId.
    
    fromState - String value for fromState.
    
    toState - String value for toState.
    
    locationId - String value for locationId.
    
    catalogObjectId - String value for catalogObjectId.
    
    catalogObjectType - String value for catalogObjectType.
    
    quantity - String value for quantity.
    
    totalPriceMoney - Money value for totalPriceMoney.
    
    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.
    
    transactionId - String value for transactionId.
    
    refundId - String value for refundId.
    
    purchaseOrderId - String value for purchaseOrderId.
    
    goodsReceiptId - String value for goodsReceiptId.
    
    adjustmentGroup - InventoryAdjustmentGroup value for adjustmentGroup.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. A unique ID generated by Square for the `InventoryAdjustment`.
    
    Returns:
    
    Returns the String
  - getReferenceId
```
public String getReferenceId()
```
    Getter for ReferenceId. An optional ID provided by the application to tie the `InventoryAdjustment` to an external system.
    
    Returns:
    
    Returns the String
  - getFromState
```
public String getFromState()
```
    Getter for FromState. Indicates the state of a tracked item quantity in the lifecycle of goods.
    
    Returns:
    
    Returns the String
  - getToState
```
public String getToState()
```
    Getter for ToState. 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
  - 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 adjustment as a decimal string. Can support up to 5 digits after the decimal point.
    
    Returns:
    
    Returns the String
  - getTotalPriceMoney
```
public Money getTotalPriceMoney()
```
    Getter for TotalPriceMoney. 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
  - getOccurredAt
```
public String getOccurredAt()
```
    Getter for OccurredAt. A client-generated RFC 3339-formatted timestamp that indicates when the inventory adjustment took place. For inventory adjustment 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 inventory adjustment is received.
    
    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 adjustment.
    
    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 adjustment.
    
    Returns:
    
    Returns the String
  - getTransactionId
```
public String getTransactionId()
```
    Getter for TransactionId. The Square-generated ID of the [Transaction]($m/Transaction) that caused the adjustment. Only relevant for payment-related state transitions.
    
    Returns:
    
    Returns the String
  - getRefundId
```
public String getRefundId()
```
    Getter for RefundId. The Square-generated ID of the [Refund]($m/Refund) that caused the adjustment. Only relevant for refund-related state transitions.
    
    Returns:
    
    Returns the String
  - getPurchaseOrderId
```
public String getPurchaseOrderId()
```
    Getter for PurchaseOrderId. The Square-generated ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
    
    Returns:
    
    Returns the String
  - getGoodsReceiptId
```
public String getGoodsReceiptId()
```
    Getter for GoodsReceiptId. The Square-generated ID of the goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
    
    Returns:
    
    Returns the String
  - getAdjustmentGroup
```
public InventoryAdjustmentGroup getAdjustmentGroup()
```
    Getter for AdjustmentGroup.
    
    Returns:
    
    Returns the InventoryAdjustmentGroup
  - 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 InventoryAdjustment into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public InventoryAdjustment.Builder toBuilder()
```
    Builds a new InventoryAdjustment.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new InventoryAdjustment.Builder object

Class InventoryAdjustment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InventoryAdjustment

Method Detail

getId

getReferenceId

getFromState

getToState

getLocationId

getCatalogObjectId

getCatalogObjectType

getQuantity

getTotalPriceMoney

getOccurredAt

getCreatedAt

getSource

getEmployeeId

getTeamMemberId

getTransactionId

getRefundId

getPurchaseOrderId

getGoodsReceiptId

getAdjustmentGroup

hashCode

equals

toString

toBuilder