DemandFlow Support Centre

INVTX: Inventory Transfer

ReferenceEntity Reference16/04/2026Updated 16/04/2026
A record of inventory being transferred between sites, or drawn down to a project.

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

PropertyValue
Entity codeINVTX
Display nameInventory Transfer
PluralInventory Transfers
Level55000

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

FieldTypeRequiredNotes
nametextYesTransfer Reference.
typeenumYesValid ids: siteTransfer (Site to Site Transfer), projectDrawdown (Project Drawdown), reservation (Stock Reservation), return (Return to Warehouse), disposal (Disposal / Write-off).
statusenumYesValid ids: requested (Requested), approved (Approved), inTransit (In Transit), completed (Completed), cancelled (Cancelled).
requestedDatedateDate Requested.
completedDatedateDate Completed.
expiryDatedateAuto-cancel if not actioned by this date

Items

FieldTypeRequiredNotes
componentIdreference → COMPYesComponent.
inventoryIdreference → COMPINVInventory Item.
qtynumberYesQuantity.
unitValuenumberUnit Value.

Source & Destination

FieldTypeRequiredNotes
fromSiteIdreference → SITEYesFrom Site.
siteIdreference → SITETo Site.
projectIdreference → PJProject.
salesOrderIdreference → SCONSales Order.
reasontext (multi-line)Reason / Notes.

Relationships

  • Lookups: componentId points at a COMP record; inventoryId points at a COMPINV record; fromSiteId points at a SITE record; siteId points at a SITE record; projectId points at a PJ record; salesOrderId points at a SCON record.

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>

See also

invtxinventorytransfertransfers

Was this article helpful?

← Back to Knowledge Base