DevicePeripheral
object type
A DevicePeripheral — the hardware a Device OWNS: barcode scanners, receipt/label printers, display poles, cash drawers, card readers, and scales. The model MUST name the AT-maintained preset registry (cannedPeripheralModels, registry v2 — merchants pick supported models, never author drivers); peripheralType + model are IMMUTABLE at birth (swapped hardware = a new peripheral), connection is mutable (re-cabling is an edit). NOT searchable (hardware config — reached via its owning Device).
Fields
| Field | Type | Notes |
|---|---|---|
id | ID ID! | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
sysId | String String! | The group-scoped human-facing system id (PH-…). |
type | String String! | The kind of record — always DevicePeripheral here. |
caption | String String! | The record’s display name — what people see it called. |
status | String String! | The FSM state: active | inactive | doomed. |
parentId | ID ID! | The parent Device; rootId = the org group; parentId!== rootId always. |
rootId | ID ID! | The org-group family root. |
createdAt | String String! | When the record was created, as a UTC timestamp. |
updatedAt | String String! | When the record last changed, as a UTC timestamp. |
revisionNum | Int Int! | How many times this record has been edited; the first save is 0. |
revision | ID ID! | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
refCaptions | RefCaption [RefCaption!]! | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
peripheralType | DevicePeripheralType DevicePeripheralType! | The canned peripheral class — set at creation, IMMUTABLE. |
model | String String! | The preset-registry model key (the preset series — cannedPeripheralModels lists the roster) — set at creation, IMMUTABLE. |
connection | DevicePeripheralConnection DevicePeripheralConnection! | How this unit attaches — mutable; must stay within the model’s supported set (kit-gated). |
readerRef | String | The Stripe Terminal reader this unit registered as: present exactly on card_reader+network peripherals (stamped at birth); IMMUTABLE. A tmr_ reference of at most 128 characters — it rides record-first into Payment.methodRef. |