Object Index
/ Definition
You are viewing an old version of the API
InventoryPhysicalCount
Object Index / Definition
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 | Description |
|---|---|
id
|
A unique ID generated by Square for the InventoryPhysicalCount. |
catalog_object_id
|
The Square generated ID of the
|
catalog_object_type
|
The |
created_at
|
A read-only timestamp in RFC 3339 format that indicates when Square received the physical count. |
employee_id
|
The Square ID of the Employee responsible for the physical count. |
location_id
|
The Square ID of the Location where the related quantity of items are being tracked. |
occurred_at
|
A client-generated timestamp in RFC 3339 format that indicates when
the physical count took place. For write actions, the |
quantity
Beta
|
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, |
reference_id
|
An optional ID provided by the application to tie the InventoryPhysicalCount to an external system. |
source
|
Read-only information about the application that submitted the physical count. |
state
|
The current |