Opening balance line items
A line of an opening balance with the starting quantity and unit cost of an inventory item.
- API name:
inventoryopeningbalanceitems - 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 | |
| Opening balance | inventoryopeningbalanceId | Reference | Yes | |
| Position | rank | Order rank | Yes | |
| Item | productitemId | Reference | ||
| Quantity | quantity | Quantity | Quantity in the catalog unit after any unit conversion on the line. | |
| Item | customitemId | Reference | ||
| Identifier | inventoryidentifierId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| On hold | isOnhold | Boolean | Yes | When enabled, the opening quantity posts to the on-hold bucket. When disabled, it posts as available. |
| Unit cost | unitCost | Unit price | Cost of the inventory per unit. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Opening balance inventoryopeningbalanceId | Inventory opening balances | owned by |
Identifier inventoryidentifierId | Inventory identifiers | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryopeningbalanceitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · API · MCP · CLI |
| Edit | update | Save changes to this line item. | App · API · MCP · CLI |
| Delete | delete | Delete this line item and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |