# 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

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (UM-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `CustomUom` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| inactive \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The parent org group; for a CustomUom parentId === rootId. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `dimensionClass` | [UomDimensionClass](/types/UomDimensionClass/) `UomDimensionClass!` | The declared dimension class — set at creation, IMMUTABLE thereafter. |
| `factorToBase` | [Float](/types/#scalars) `Float!` | The conversion factor to the class BASE unit (count=each · mass=kg · volume=l · length=m · area=m2 · time=day); > 0, finite. |
| `code` | [String](/types/#scalars) | Optional mutable merchant reference code; uniqueness NOT enforced (the code stance). |

## Used by

- [createCustomUom](/reference/custom-uom/createCustomUom/)
- [customUom](/reference/custom-uom/customUom/)
- [deactivateCustomUom](/reference/custom-uom/deactivateCustomUom/)
- [doomCustomUom](/reference/custom-uom/doomCustomUom/)
- [reactivateCustomUom](/reference/custom-uom/reactivateCustomUom/)
- [updateCustomUom](/reference/custom-uom/updateCustomUom/)