InventoryAdjustment
December 17, 2019 ยท View on GitHub
Description
Represents a change in state or quantity of product inventory at a particular time and location.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | A unique ID generated by Square for the `InventoryAdjustment`. | [optional] |
| reference_id | getReferenceId() | setReferenceId($value) | string | An optional ID provided by the application to tie the `InventoryAdjustment` to an external system. | [optional] |
| from_state | getFromState() | setFromState($value) | string | The `InventoryState` of the related quantity of items before the adjustment. See InventoryState for possible values | [optional] |
| to_state | getToState() | setToState($value) | string | The `InventoryState` of the related quantity of items after the adjustment. See InventoryState for possible values | [optional] |
| location_id | getLocationId() | setLocationId($value) | string | The Square ID of the `Location` where the related quantity of items are being tracked. | [optional] |
| catalog_object_id | getCatalogObjectId() | setCatalogObjectId($value) | string | The Square generated ID of the `CatalogObject` being tracked. | [optional] |
| catalog_object_type | getCatalogObjectType() | setCatalogObjectType($value) | string | The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional] |
| quantity | getQuantity() | setQuantity($value) | string | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. Important: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read Decimal Quantities (BETA) for more information. | [optional] [beta] |
| total_price_money | getTotalPriceMoney() | setTotalPriceMoney($value) | \SquareConnect\Model\Money | The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative. | [optional] |
| occurred_at | getOccurredAt() | setOccurredAt($value) | string | A client-generated timestamp in RFC 3339 format that indicates when the adjustment 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. | [optional] |
| created_at | getCreatedAt() | setCreatedAt($value) | string | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional] |
| source | getSource() | setSource($value) | \SquareConnect\Model\SourceApplication | Read-only information about the application that caused the inventory adjustment. | [optional] |
| employee_id | getEmployeeId() | setEmployeeId($value) | string | The Square ID of the `Employee` responsible for the inventory adjustment. | [optional] |
| transaction_id | getTransactionId() | setTransactionId($value) | string | The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions. | [optional] |
| refund_id | getRefundId() | setRefundId($value) | string | The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions. | [optional] |
| purchase_order_id | getPurchaseOrderId() | setPurchaseOrderId($value) | string | The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app. | [optional] |
| goods_receipt_id | getGoodsReceiptId() | setGoodsReceiptId($value) | string | The read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app. | [optional] |
Note: All properties are protected and only accessed via getters and setters.