Inventory write-offs
Unusable or expired inventory removed from stock.
- API name:
inventoryscraps - 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 | |
| Name | label | Text | ||
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Quantity | quantity | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Catalog | catalog | Constant | Fixed option from the allowed set for this field. | |
| Unit | catalogunit | Unit | ||
| Item | productitemId | Reference | ||
| Item | customitemId | Reference | ||
| Identifier | inventoryidentifierId | Reference | ||
| On hold | isOnhold | Boolean | Yes | When enabled, the write-off removes on-hold quantity. When disabled, it removes available quantity. |
| Location | sitelocationId | Reference | Yes | |
| Zone | siteareaId | Reference | Yes | |
| Reason | reason | Option (Select) | Yes | Fixed option from the allowed set for this field. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| 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
| Field | Points to | Kind |
|---|---|---|
Identifier inventoryidentifierId | Inventory identifiers | reference |
Location sitelocationId | Site locations | reference |
Zone siteareaId | Site areas | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryscraps.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new write-off. | App · API · MCP · CLI |
| Edit | update | Save changes to this write-off. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this write-off. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this write-off. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this write-off again. | App · API · MCP · CLI |
| Archive | archive | Retire this write-off from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this write-off to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this write-off and the data that belongs with it. This cannot be undone. | App · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.