Stock by company

The current on-hand, available, on-hold, reserved and allocated quantities of an item for one company.

API name: inventorybalances
Domain: Inventory
Modules: Inventory analytics

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
Customer	`customerId`	Reference		Customer that owns consigned or maquila stock. Empty when ownership is Company.
On hand	`onhand`	Quantity	Yes	Current quantity at the company, 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.
On hold	`onhold`	Quantity	Yes	Quantity blocked due to operational reasons, such as quality inspection, discrepancies, or administrative review.
In transit	`intransit`	Quantity	Yes	Quantity shipped and not yet received at this company. It is not part of on hand.
Reserved	`reserved`	Quantity	Yes	Quantity committed to demand and still at the company.
Allocated	`allocated`	Quantity	Yes	Quantity set aside for a demand document. Available subtracts it.
Available	`available`	Quantity	Yes	Quantity at the company that can be allocated. Calculated as on hand minus on hold minus reserved minus allocated.
Item	`customitemId`	Reference
Catalog	`catalog`	Constant	Yes	Fixed option from the allowed set for this field.
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		True when at least one identity at this company has on hand greater than zero and is not nominal.
Created at	`createdAt`	Date and Time	Yes
Updated at	`updatedAt`	Date and Time	Yes

Relations

Field	Points to	Kind
Customer `customerId`	Customers	reference