INVTX: Inventory Transfer
A record of inventory being transferred between sites, or drawn down to a project.
Default definition. This article describes the default
INVTX definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches INVTX.Entity properties
| Property | Value |
|---|---|
| Entity code | INVTX |
| Display name | Inventory Transfer |
| Plural | Inventory Transfers |
| Level | 55000 |
Use cases
Tracks the movement of inventory items between warehouse sites or allocation to projects. Three-column layout: left (30%) has transfer details (name, type, status, dates), middle (30%) has what is being moved (component lookup, inventory item, quantity, unit value), right (40%) has source/destination (from site, to site, project link) and notes. The type field distinguishes site-to-site transfers from project drawdowns.
Fields
Transfer Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Transfer Reference. |
type | enum | Yes | Valid ids: siteTransfer (Site to Site Transfer), projectDrawdown (Project Drawdown), reservation (Stock Reservation), return (Return to Warehouse), disposal (Disposal / Write-off). |
status | enum | Yes | Valid ids: requested (Requested), approved (Approved), inTransit (In Transit), completed (Completed), cancelled (Cancelled). |
requestedDate | date | Date Requested. | |
completedDate | date | Date Completed. | |
expiryDate | date | Auto-cancel if not actioned by this date |
Items
| Field | Type | Required | Notes |
|---|---|---|---|
componentId | reference → COMP | Yes | Component. |
inventoryId | reference → COMPINV | Inventory Item. | |
qty | number | Yes | Quantity. |
unitValue | number | Unit Value. |
Source & Destination
| Field | Type | Required | Notes |
|---|---|---|---|
fromSiteId | reference → SITE | Yes | From Site. |
siteId | reference → SITE | To Site. | |
projectId | reference → PJ | Project. | |
salesOrderId | reference → SCON | Sales Order. | |
reason | text (multi-line) | Reason / Notes. |
Relationships
- Lookups:
componentIdpoints at aCOMPrecord;inventoryIdpoints at aCOMPINVrecord;fromSiteIdpoints at aSITErecord;siteIdpoints at aSITErecord;projectIdpoints at aPJrecord;salesOrderIdpoints at aSCONrecord.
Creating a Inventory Transfer via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "INVTX",
"level": 55000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"type": "siteTransfer",
"status": "requested",
"componentId": ""
}
Listing Inventory Transfers
# All records in your tenant
GET /v1/entities/INVTX/SUB:<your-sub-id>