AlmondTill/G3N API

Transfer

object type

A stock transfer: ONE shipment event moving stock between two LogicalFacilities of the SAME org group (the never-cross-group law IS the tenancy boundary; the source and destination ORGS may differ = intercompany, attribution stamped at birth). LIGHT weight (same physical location — birth-derived from the LF-PF-PFL spine) completes in the ONE submit step (no reserve, no in_transit). Cancel is pre-ship ONLY; cancelled is the ONE doomed terminal (lists filter it); completed/closed are IMMUTABLE non-doomed history — a write there refuses CONFLICT/IMMUTABLE.

Fields

FieldTypeNotes
idID ID!The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it.
sysIdString String!The group-scoped human-facing system id (TF-…).
typeString String!The kind of record — always Transfer here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: draft | pending_send_approval | ready | in_transit | pending_receive_approval | partially_received | received | in_dispute | completed | closed | cancelled.
parentIdID ID!The parent SOURCE LogicalFacility; for a Transfer parentId!== rootId.
rootIdID ID!The org-group family root.
createdAtString String!When the record was created, as a UTC timestamp.
updatedAtString String!When the record last changed, as a UTC timestamp.
revisionNumInt Int!How many times this record has been edited; the first save is 0.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption.
destinationLogicalFacilityIdID ID!The destination LogicalFacility (pointer ref; never the parent — a same-LF pair is a relocation, refused at birth: relocateStock is the doc-less sibling).
weightString String!The transfer weight — light (same PFL: immediate handoff, no in_transit) or shipped (the full saga). BIRTH-DERIVED from the live LF-PF-PFL spine and IMMUTABLE.
sourceOrganizationIdID ID!The source LF owning org (spine-derived at birth — the PF parent; intercompany attribution). IMMUTABLE.
destinationOrganizationIdID ID!The destination LF owning org (spine-derived at birth; == sourceOrganizationId for intra-org moves). IMMUTABLE.
expectedArrivalAtStringThe expected arrival instant (UTC ISO-8601; shipped metadata — drives the future in-transit aging strand). Lands at SHIP, absent before.
carrierRefsString [String!]Carrier / tracking references. Land at SHIP, absent before.
linesTransferLine [TransferLine!]!The EMBEDDED lines.

Used by