Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
25 lines (19 loc) · 3.42 KB

InventoryPhysicalCount.md

File metadata and controls

25 lines (19 loc) · 3.42 KB

InventoryPhysicalCount

Description

Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.

Properties

Name Getter Setter Type Description Notes
id getId() setId($value) string A unique ID generated by Square for the `InventoryPhysicalCount`. [optional]
reference_id getReferenceId() setReferenceId($value) string An optional ID provided by the application to tie the `InventoryPhysicalCount` to an external system. [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]
state getState() setState($value) string The current `InventoryState` for the related quantity of items. 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]
quantity getQuantity() setQuantity($value) string The number of items affected by the physical count 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]
source getSource() setSource($value) \SquareConnect\Model\SourceApplication Read-only information about the application that submitted the physical count. [optional]
employee_id getEmployeeId() setEmployeeId($value) string The Square ID of the `Employee` responsible for the physical count. [optional]
occurred_at getOccurredAt() setOccurredAt($value) string A client-generated timestamp in RFC 3339 format that indicates when the physical count 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 physical count. [optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]