Company stock history
The on-hand, available, on-hold and reserved quantities of an item for one company at the end of a date.
- API name:
inventorybalancesnapshots - Domain: Inventory
- Modules: Inventory analytics, Inventory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Item | productitemId | Reference | Yes | |
| Day | date | Date | Yes | Civil date (YYYY-MM-DD) of the end-of-date snapshot in the organization timezone. |
| Customer | customerId | Reference | ||
| On hand | onhand | Quantity | Yes | Quantity at the company at the end of that date, regardless of tracking identity or physical conformity. Does not mean every unit is an interchangeable instance of the nominal product. On hand equals available plus on hold plus reserved plus allocated. Does not include In transit. |
| Available | available | Quantity | Yes | Quantity at the company that could be allocated at the end of that date. Calculated as on hand minus on hold minus reserved minus allocated. |
| On hold | onhold | Quantity | Yes | Quantity blocked due to operational reasons at the end of that date, such as quality inspection, discrepancies, or administrative review. |
| Reserved | reserved | Quantity | Yes | Quantity in the unit of measure used on this line. |
| Allocated | allocated | Quantity | Yes | Quantity set aside for a demand document at the end of that date. Available subtracts it. |
| Unit | catalogunit | Unit | ||
| Ownership | ownership | Constant | Yes | Beneficial owner of the stock. The custodial company remains the record's company. |
| Has non-nominal stock | hasNonNominal | Boolean | Yes | True when at least one identity at this company had on hand greater than zero and was not nominal at the end of that date. |
| Created at | createdAt | Date and Time | Yes |
Relations
| Field | Points to | Kind |
|---|---|---|
Item productitemId | Product items | reference |
Customer customerId | Customers | reference |