AlmondTill/G3N API

CustomUom

object type

A custom unit of measure — a group-defined unit that MUST declare its dimension class + its conversion factor to the class BASE unit (STRICT: convertible by construction, e.g. Bolt = 25 m). The canned UoM registry (cannedUoms — the locked classes + maintained conversions) is registry DATA, not constructs; pack relationships (1 case = 12 each) are NOT UoM conversions. Referenced UoMs cannot be doomed (the guard arms with the Variant stock UoM).

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 (UM-…).
typeString String!The kind of record — always CustomUom here.
captionString String!The record’s display name — what people see it called.
statusString String!The FSM state: active | inactive | doomed.
parentIdID ID!The parent org group; for a CustomUom 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.
dimensionClassUomDimensionClass UomDimensionClass!The declared dimension class — set at creation, IMMUTABLE thereafter.
factorToBaseFloat Float!The conversion factor to the class BASE unit (count=each · mass=kg · volume=l · length=m · area=m2 · time=day); > 0, finite.
codeStringOptional mutable merchant reference code; uniqueness NOT enforced (the code stance).

Used by